Create API Box Snapshot

curl --request POST \
  --url https://api.continuouslabs.ai/v1/apibox-snapshots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'request={
  "credential_ids": [
    "<string>"
  ],
  "filter": [
    "<string>"
  ],
  "instructions": "<string>",
  "model": "<string>",
  "name": "<string>",
  "review_rounds": 1,
  "timeout_seconds": 28800
};type=application/json' \
  --form 'spec=@example-file;type=application/octet-stream'

package main

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

func main() {

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

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request\"\r\nContent-Type: application/json\r\n\r\n{\r\n  \"credential_ids\": [\r\n    \"<string>\"\r\n  ],\r\n  \"filter\": [\r\n    \"<string>\"\r\n  ],\r\n  \"instructions\": \"<string>\",\r\n  \"model\": \"<string>\",\r\n  \"name\": \"<string>\",\r\n  \"review_rounds\": 1,\r\n  \"timeout_seconds\": 28800\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"spec\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "multipart/form-data")

	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-snapshots"

files = { "spec": ("example-file", open("example-file", "rb"), "application/octet-stream") }
files["request"] = (None, "{\n  \"credential_ids\": [\n    \"<string>\"\n  ],\n  \"filter\": [\n    \"<string>\"\n  ],\n  \"instructions\": \"<string>\",\n  \"model\": \"<string>\",\n  \"name\": \"<string>\",\n  \"review_rounds\": 1,\n  \"timeout_seconds\": 28800\n}", "application/json")
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('request', '{
  "credential_ids": [
    "<string>"
  ],
  "filter": [
    "<string>"
  ],
  "instructions": "<string>",
  "model": "<string>",
  "name": "<string>",
  "review_rounds": 1,
  "timeout_seconds": 28800
}');
form.append('spec', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

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

{
  "build": {
    "hidden_limitations": 1,
    "last_submission": "accepted",
    "last_tool": "<string>",
    "limitations": [
      {
        "location": "<string>",
        "message": "<string>",
        "operations": [
          "<string>"
        ],
        "reviewed": true
      }
    ],
    "model": "gpt-6-astra",
    "phase": "research",
    "review_round": 5,
    "review_rounds": 5,
    "stage": "derive",
    "submissions": 1,
    "tool_calls": 1,
    "waited_seconds": 1,
    "waiting": {
      "credential_ids": [
        "<string>"
      ],
      "deadline": "2023-11-07T05:31:56Z",
      "reason": "<string>",
      "since": "2023-11-07T05:31:56Z"
    },
    "warnings": [
      {
        "code": "spec.enum_duplicate",
        "location": "<string>",
        "message": "<string>",
        "operations": [
          "<string>"
        ]
      }
    ]
  },
  "composition": {
    "entities": 123,
    "operations": 123,
    "sample": true
  },
  "created_at": "2023-11-07T05:31:56Z",
  "credential_ids": [
    "<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>"
        }
      ]
    }
  },
  "hidden_limitations": 1,
  "id": "<string>",
  "instructions": "<string>",
  "limitations": [
    {
      "location": "<string>",
      "message": "<string>",
      "operations": [
        "<string>"
      ],
      "reviewed": true
    }
  ],
  "metadata": "<unknown>",
  "name": "<string>",
  "research": {
    "bytes": 1,
    "pages": 1,
    "status": "pending"
  },
  "source": "catalog",
  "spec_kind": "openapi",
  "status": "pending"
}

API Box Snapshots

Create API Box Snapshot

Starts an asynchronous build and returns the API Box Snapshot with status pending. Get the Snapshot until its status is ready, failed or canceled; API Boxes start from a ready one. The build is a Simulator build in api mode, run in real time: the built service has no simulated clock, and its scheduled work runs at the first request at or after its time. Builds queue with Simulator builds and count toward the same quotas. Send multipart/form-data with a JSON part named request, a file part named spec with the OpenAPI, WSDL or GraphQL document, and optional file parts named document with vendor documentation.

POST

https://api.continuouslabs.ai

apibox-snapshots

curl --request POST \
  --url https://api.continuouslabs.ai/v1/apibox-snapshots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'request={
  "credential_ids": [
    "<string>"
  ],
  "filter": [
    "<string>"
  ],
  "instructions": "<string>",
  "model": "<string>",
  "name": "<string>",
  "review_rounds": 1,
  "timeout_seconds": 28800
};type=application/json' \
  --form 'spec=@example-file;type=application/octet-stream'

package main

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

func main() {

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

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request\"\r\nContent-Type: application/json\r\n\r\n{\r\n  \"credential_ids\": [\r\n    \"<string>\"\r\n  ],\r\n  \"filter\": [\r\n    \"<string>\"\r\n  ],\r\n  \"instructions\": \"<string>\",\r\n  \"model\": \"<string>\",\r\n  \"name\": \"<string>\",\r\n  \"review_rounds\": 1,\r\n  \"timeout_seconds\": 28800\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"spec\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "multipart/form-data")

	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-snapshots"

files = { "spec": ("example-file", open("example-file", "rb"), "application/octet-stream") }
files["request"] = (None, "{\n  \"credential_ids\": [\n    \"<string>\"\n  ],\n  \"filter\": [\n    \"<string>\"\n  ],\n  \"instructions\": \"<string>\",\n  \"model\": \"<string>\",\n  \"name\": \"<string>\",\n  \"review_rounds\": 1,\n  \"timeout_seconds\": 28800\n}", "application/json")
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('request', '{
  "credential_ids": [
    "<string>"
  ],
  "filter": [
    "<string>"
  ],
  "instructions": "<string>",
  "model": "<string>",
  "name": "<string>",
  "review_rounds": 1,
  "timeout_seconds": 28800
}');
form.append('spec', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

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

{
  "build": {
    "hidden_limitations": 1,
    "last_submission": "accepted",
    "last_tool": "<string>",
    "limitations": [
      {
        "location": "<string>",
        "message": "<string>",
        "operations": [
          "<string>"
        ],
        "reviewed": true
      }
    ],
    "model": "gpt-6-astra",
    "phase": "research",
    "review_round": 5,
    "review_rounds": 5,
    "stage": "derive",
    "submissions": 1,
    "tool_calls": 1,
    "waited_seconds": 1,
    "waiting": {
      "credential_ids": [
        "<string>"
      ],
      "deadline": "2023-11-07T05:31:56Z",
      "reason": "<string>",
      "since": "2023-11-07T05:31:56Z"
    },
    "warnings": [
      {
        "code": "spec.enum_duplicate",
        "location": "<string>",
        "message": "<string>",
        "operations": [
          "<string>"
        ]
      }
    ]
  },
  "composition": {
    "entities": 123,
    "operations": 123,
    "sample": true
  },
  "created_at": "2023-11-07T05:31:56Z",
  "credential_ids": [
    "<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>"
        }
      ]
    }
  },
  "hidden_limitations": 1,
  "id": "<string>",
  "instructions": "<string>",
  "limitations": [
    {
      "location": "<string>",
      "message": "<string>",
      "operations": [
        "<string>"
      ],
      "reviewed": true
    }
  ],
  "metadata": "<unknown>",
  "name": "<string>",
  "research": {
    "bytes": 1,
    "pages": 1,
    "status": "pending"
  },
  "source": "catalog",
  "spec_kind": "openapi",
  "status": "pending"
}

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 original result with its status; the same key with a different request returns 409 idempotency_conflict. Without a key, each request creates a new resource. The key is recorded before the build starts, so a retry never starts a second build.

Maximum string length: 256

Body

multipart/form-data

request

object

required

Build options as JSON.

Show child attributes

document

file[]

Vendor documentation the builder and reviewer read before they start, as repeated file parts: UTF-8 text (.md, .txt, .html, .json, .yaml, .xml, .csv) or PDF (.pdf). The documents share the request body limit with the spec.

spec

file

OpenAPI, WSDL or GraphQL document, UTF-8 encoded, at most 64 MiB.

Response

Accepted

build

object | null

required

The build's latest progress report, or null before the first report. A settled Snapshot keeps its last report. A build waiting for its live credentials resumes with POST /v1/apibox-snapshots/{id}/resume.

Show child attributes

composition

object | null

required

What a ready Snapshot serves, or null.

Show child attributes

created_at

string<date-time>

required

Snapshot creation time.

credential_ids

string[]

required

Workspace credentials the build was allowed to call real systems with. Empty when none.

error

object | null

required

Why the build failed or was canceled, or null.

Show child attributes

hidden_limitations

integer<int64>

required

Limitations the Snapshot records beyond those listed in limitations.

Required range: x >= 0

string

required

API Box Snapshot ID.

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

instructions

string

required

The instructions the build followed, or empty when none were given.

limitations

object[]

required

Behavior the Snapshot does not serve like the real system, most important first, whether it was built or published. Empty when none.

Show child attributes

metadata

any

required

Customer JSON metadata, or null.

name

string

required

Snapshot name. The ID is its identity, and names need not be unique.

Maximum string length: 128

research

object | null

required

The build's research stage, or null when research did not run.

Show child attributes

source

enum<string>

required

catalog for a Snapshot Continuous publishes, build for one built or published into the workspace.

Available options:

catalog,

build

spec_kind

enum<string> | null

required

The specification the Snapshot was built from, or null until the build has read it.

Available options:

openapi,

wsdl,

graphql,

null

status

enum<string>

required

pending while waiting for capacity; building while the build runs; ready when API Boxes can start from it; failed when the build failed; canceled when a cancel request took effect.

Available options:

pending,

building,

ready,

failed,

canceled

Using the API

API Boxes

API Box Snapshots

Web Boxes

Web Box Snapshots

MCP Boxes

MCP Box Snapshots

Cloud Boxes

Cloud Box Snapshots

Credentials

Deprecated

Create API Box Snapshot

Authorizations

Headers

Body

Response