Create API Box - Continuous

Create API Box

curl --request POST \
  --url https://api.continuouslabs.ai/v1/apibox \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "snapshot_id": "abs_01J8Z5X4K70000000000000002"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.continuouslabs.ai/v1/apibox"

	payload := strings.NewReader("{\n  \"snapshot_id\": \"abs_01J8Z5X4K70000000000000002\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

import requests

url = "https://api.continuouslabs.ai/v1/apibox"

payload = { "snapshot_id": "abs_01J8Z5X4K70000000000000002" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({snapshot_id: 'abs_01J8Z5X4K70000000000000002'})
};

fetch('https://api.continuouslabs.ai/v1/apibox', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "apibox": {
    "created_at": "2023-11-07T05:31:56Z",
    "endpoint": "<string>",
    "error": {
      "agent_message": "<string>",
      "code": "build_failed",
      "detail": "<string>",
      "reason": "canceled",
      "validation": {
        "issues": [
          {
            "code": "<string>",
            "kind": "invalid",
            "location": "<string>",
            "message": "<string>",
            "operation": "<string>",
            "suggestion": "<string>"
          }
        ]
      }
    },
    "id": "<string>",
    "include_sample_data": true,
    "metadata": "<unknown>",
    "name": "<string>",
    "snapshot_id": "<string>",
    "status": "starting"
  },
  "token": "<string>"
}

POST

https://api.continuouslabs.ai

/

v1

/

apibox

Create API Box

curl --request POST \
  --url https://api.continuouslabs.ai/v1/apibox \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "snapshot_id": "abs_01J8Z5X4K70000000000000002"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.continuouslabs.ai/v1/apibox"

	payload := strings.NewReader("{\n  \"snapshot_id\": \"abs_01J8Z5X4K70000000000000002\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

import requests

url = "https://api.continuouslabs.ai/v1/apibox"

payload = { "snapshot_id": "abs_01J8Z5X4K70000000000000002" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({snapshot_id: 'abs_01J8Z5X4K70000000000000002'})
};

fetch('https://api.continuouslabs.ai/v1/apibox', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "apibox": {
    "created_at": "2023-11-07T05:31:56Z",
    "endpoint": "<string>",
    "error": {
      "agent_message": "<string>",
      "code": "build_failed",
      "detail": "<string>",
      "reason": "canceled",
      "validation": {
        "issues": [
          {
            "code": "<string>",
            "kind": "invalid",
            "location": "<string>",
            "message": "<string>",
            "operation": "<string>",
            "suggestion": "<string>"
          }
        ]
      }
    },
    "id": "<string>",
    "include_sample_data": true,
    "metadata": "<unknown>",
    "name": "<string>",
    "snapshot_id": "<string>",
    "status": "starting"
  },
  "token": "<string>"
}

Authorizations

Authorization

string

header

required

Use a Continuous API key. Send it in the Authorization header as a Bearer token.

Headers

Idempotency-Key

string

Optional key for retrying this create safely. A retry with the same key and request returns the same API Box and token. The same key with a different request returns 409 idempotency_conflict.

Maximum string length: 256

Body

application/json

snapshot_id

string

required

A ready API Box Snapshot of the workspace or the catalog.

Pattern: ^abs_[0-9A-HJKMNP-TV-Z]{26}$

include_sample_data

boolean

Start with the Snapshot's sample data: a realistic account loaded on top of its seed before the first request. Defaults to false, a brand-new workspace. Requires a Snapshot that carries sample data; see its composition.

metadata

any

Customer JSON metadata, up to 16 KiB and 64 nesting levels.

name

string

Name for the API Box. Omission generates a name.

Maximum string length: 128

Response

Accepted

apibox

object

required

The API Box.

Show child attributes

token

string | null

required

The API Box's token, which lasts until the API Box is deleted. It is null only on a retried create whose first attempt stored no token; a start then issues one.