Skip to main content
POST
/
sandbox
/
jira
/
{sandbox_id}
/
initialize
Initialize jira sandbox with data
curl --request POST \
  --url https://api.klavis.ai/sandbox/jira/{sandbox_id}/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projects": [
    {
      "key": "<string>",
      "name": "<string>",
      "description": "<string>",
      "project_type": "software",
      "issues": [
        {
          "summary": "<string>",
          "description": "<string>",
          "issue_type": "Task",
          "priority": "<string>",
          "sprint_name": "<string>",
          "comments": [
            {
              "body": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "boards": [
    {
      "name": "<string>",
      "type": "scrum",
      "project_key": "<string>",
      "filter_jql": "<string>"
    }
  ],
  "sprints": [
    {
      "name": "<string>",
      "start_date": "<string>",
      "end_date": "<string>",
      "origin_board_name": "<string>",
      "goal": "<string>",
      "state": "<string>"
    }
  ]
}
'
{
  "sandbox_id": "<string>",
  "status": "idle",
  "message": "<string>",
  "records_created": {}
}

Authorizations

Authorization
string
header
required

Your Klavis AI API key.

Path Parameters

sandbox_id
string
required

The unique sandbox identifier

Body

application/json

Complete Jira sandbox data structure.

Relational structure for initialization:

  • Projects contain Issues
  • Boards refer to Projects (via key)
  • Sprints refer to Boards (via name)
  • Issues can refer to Sprints (via name)
projects
JiraProject · object[]

List of projects with their issues

boards
JiraBoard · object[]

List of boards

sprints
JiraSprint · object[]

List of sprints

Response

Successful Response

Response model for sandbox initialization

sandbox_id
string
required

Sandbox identifier

status
enum<string>
required

Current status

Available options:
idle,
occupied
message
string
required

Initialization result message

records_created
Records Created · object

Count of records created per object type