API Playground | Zyeon UI

Preview in your theme

ready · the live console — press Send (or Cmd/Ctrl+Enter) and the injected fetcher answers after 900 ms; Cancel, or Escape while it is in flight, aborts the signal and hands focus back to Send. The Authorization header is masked, and the cURL snippet substitutes $AUTHORIZATION for it.

Create document

Create a document in a workspace and queue it for indexing.

POST

/v1/workspaces/{workspaceId}/documents

https://api.example.com/v1/workspaces/ws_91o14l6o/documents?locale=en-US&dry_run=false

Path parameters

workspaceIdstringrequired

The workspace the document is filed under.

Query parameters

localeenumoptional

Language the document is indexed as. Omitted when not set.

dry_runbooleanoptional

Validate the payload and return the plan without writing anything.

Headers

Authorizationstringrequiredsecret

Bearer token. Masked on screen and replaced by $AUTHORIZATION in the snippet.

Idempotency-Keystringoptional

Replaying the same key returns the first result instead of a second document.

X-Request-Idstringoptional

Echoed back in the response headers. Left empty it is simply not sent.

Bodyapplication/jsonrequired

Checked as JSON before anything is sent, because a 400 from a typo teaches nobody anything.

cURL

curl -X POST "https://api.example.com/v1/workspaces/ws_91o14l6o/documents?locale=en-US&dry_run=false" \
  -H "Authorization: $AUTHORIZATION" \
  -H "Idempotency-Key: 5af49dc3-5b57-434d-bd24-8e9b442afade" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Q3 board summary",
  "collection": "col_9d2f",
  "tags": ["board", "q3"],
  "content": {
    "format": "markdown",
    "value": "# Q3\n\nRevenue is up 12% quarter on quarter."
  }
}'

Secrets are substituted with shell variables, so the snippet is safe to paste into an issue and still runs once you export them.

Response

Nothing sent yet. The status, timing, size and headers of the reply land here.

ready · a 201 already in the pane from lastResponse, so the response pane renders with no request having been made: status class, fetcher-reported timing, byte size, four headers behind the disclosure, and a compact JSON body the Pretty toggle reformats.

Create document

Create a document in a workspace and queue it for indexing.

POST

/v1/workspaces/{workspaceId}/documents

https://api.example.com/v1/workspaces/ws_91o14l6o/documents?locale=en-US&dry_run=false

Path parameters

workspaceIdstringrequired

The workspace the document is filed under.

Query parameters

localeenumoptional

Language the document is indexed as. Omitted when not set.

dry_runbooleanoptional

Validate the payload and return the plan without writing anything.

Headers

Authorizationstringrequiredsecret

Bearer token. Masked on screen and replaced by $AUTHORIZATION in the snippet.

Idempotency-Keystringoptional

Replaying the same key returns the first result instead of a second document.

X-Request-Idstringoptional

Echoed back in the response headers. Left empty it is simply not sent.

Bodyapplication/jsonrequired

Checked as JSON before anything is sent, because a 400 from a typo teaches nobody anything.

cURL

curl -X POST "https://api.example.com/v1/workspaces/ws_91o14l6o/documents?locale=en-US&dry_run=false" \
  -H "Authorization: $AUTHORIZATION" \
  -H "Idempotency-Key: 5af49dc3-5b57-434d-bd24-8e9b442afade" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Q3 board summary",
  "collection": "col_9d2f",
  "tags": ["board", "q3"],
  "content": {
    "format": "markdown",
    "value": "# Q3\n\nRevenue is up 12% quarter on quarter."
  }
}'

Secrets are substituted with shell variables, so the snippet is safe to paste into an issue and still runs once you export them.

Response

201 CreatedSuccess342 ms191 B

{
  "id": "doc_xnr53sbj8jep",
  "object": "document",
  "status": "queued",
  "workspace": "ws_8f31c2a4",
  "title": "Q3 board summary",
  "tags": [
    "board",
    "q3"
  ],
  "indexing": {
    "state": "pending",
    "estimated_seconds": 8
  }
}

content-type: application/json; charset=utf-8
x-request-id: req_7f2a1c9e4b
x-ratelimit-remaining: 4996
location: https://api.example.com/v1/workspaces/ws_8f31c2a4/documents/doc_9f2b

ready · a 502 whose body is HTML, not JSON — the Pretty toggle locks to raw and says so, Set-Cookie legitimately repeats, and 12040 ms crosses into seconds. Send here is wired to a fetcher that rejects, which paints the failed phase.

Create document

Create a document in a workspace and queue it for indexing.

POST

/v1/workspaces/{workspaceId}/documents

https://api.example.com/v1/workspaces/ws_91o14l6o/documents?locale=en-US&dry_run=false

Path parameters

workspaceIdstringrequired

The workspace the document is filed under.

Query parameters

localeenumoptional

Language the document is indexed as. Omitted when not set.

dry_runbooleanoptional

Validate the payload and return the plan without writing anything.

Headers

Authorizationstringrequiredsecret

Bearer token. Masked on screen and replaced by $AUTHORIZATION in the snippet.

Idempotency-Keystringoptional

Replaying the same key returns the first result instead of a second document.

X-Request-Idstringoptional

Echoed back in the response headers. Left empty it is simply not sent.

Bodyapplication/jsonrequired

Checked as JSON before anything is sent, because a 400 from a typo teaches nobody anything.

cURL

curl -X POST "https://api.example.com/v1/workspaces/ws_91o14l6o/documents?locale=en-US&dry_run=false" \
  -H "Authorization: $AUTHORIZATION" \
  -H "Idempotency-Key: 5af49dc3-5b57-434d-bd24-8e9b442afade" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Q3 board summary",
  "collection": "col_9d2f",
  "tags": ["board", "q3"],
  "content": {
    "format": "markdown",
    "value": "# Q3\n\nRevenue is up 12% quarter on quarter."
  }
}'

Secrets are substituted with shell variables, so the snippet is safe to paste into an issue and still runs once you export them.

Response

502 Bad GatewayServer error12.04 s1.5 KB

Not JSON — showing raw

<html>
  <head><title>502 Bad Gateway</title></head>
  <body>
    <center><h1>502 Bad Gateway</h1></center>
    <hr><center>edge-proxy/1.25.3</center>
  </body>
</html>

empty · nothing selected — status 'ready' with a null operation lands here too, because a console with nothing to call is not ready, it is idle.

Create document

No operation selected

Pick an endpoint and its parameters, headers and body editors are generated here from the operation definition.

loading · the title survives because it is known before the definition answers; four skeleton parameter rows plus a response placeholder, aria-busy on the root, pulse off under prefers-reduced-motion.

Create document

error · the definition itself failed. onRetry is wired (asked 0×) and the button locks itself until the host actually reacts — here every press changes the message, which re-arms it. No timer, so there is nothing to clean up.

Create document

The operation definition could not be loaded

The OpenAPI document responded with 403. Attempt 1 has nothing to call.

ready · degenerate definition — a {version} placeholder no parameter declares, a required tenantId with no value, an exportId holding a slash and a space, an enum with no options falling back to text, 'twelve' in a number, 'yes' in a boolean, a value full of shell metacharacters, a 50-character header name, a body template that is not JSON, and an opaque response with no code, no headers and no body. Press Send: it is guarded, and it explains itself instead of firing.

Export tenant archive · edge cases

Deliberately broken definition — the console has to say so instead of sending nonsense.

GET

/v{version}/tenants/{tenantId}/exports/{exportId}

https://api.example.com/v{version}/tenants/{tenantId}/exports/exp%2F2026-08%2004?fields=id%2Csize&page=twelve&q=it's%20a%20%22quoted%22%20value%20%26%20more&include_deleted=yes

Path parameters

tenantIdstringrequired

Required and empty: the URL keeps the braces and Send stays guarded.

exportIdstringrequired

Contains a slash and a space, so it has to be percent-encoded before it is a path segment.

Query parameters

fieldsenumoptional

An enum whose options never arrived — it falls back to a free text input.

pagenumberoptional

Not a number. The message names the parameter rather than saying 'invalid input'.

qstringoptional

Quotes, an ampersand and a space: the snippet has to survive the shell as well as the URL.

include_deletedbooleanoptional

A boolean that is neither true nor false.

Headers

X-Api-Keystringrequiredsecret

A second secret, to prove the variable name comes from the header rather than a fixed word.

X-Extremely-Long-Downstream-Correlation-Identifierstringoptional

An unbroken 50-character header name with a 68-character value, to prove the row wraps instead of overflowing.

Bodyapplication/jsonrequired

Required, and not valid JSON — Send explains which of the two problems it is.

The path uses {version}, which no parameter declares. Nothing can fill it in.

cURL

curl -X GET "https://api.example.com/v{version}/tenants/{tenantId}/exports/exp%2F2026-08%2004?fields=id%2Csize&page=twelve&q=it's%20a%20%22quoted%22%20value%20%26%20more&include_deleted=yes" \
  -H "X-Api-Key: $X_API_KEY" \
  -H "X-Extremely-Long-Downstream-Correlation-Identifier: corr-8f31c2a49d7e6b5f0a3c2d1e8b7a6f5e4d3c2b1a0f9e8d7c6b5a4938271605f" \
  -H "Content-Type: application/json" \
  -d '{
  "format": csv,
  "compress": true,
}'

Secrets are substituted with shell variables, so the snippet is safe to paste into an issue and still runs once you export them.

Response

0 (opaque)Unknown status<1 ms0 B (from body text)

(empty body)

Loading preview…

This component is part of Pro

The install command, prompt and concept map are included with a Pro license — one purchase unlocks every Pro component, forever.

Unlock with Pro

curl -X POST "https://api.example.com/v1/workspaces/ws_91o14l6o/documents?locale=en-US&dry_run=false" \ -H "Authorization: $AUTHORIZATION" \ -H "Idempotency-Key: 5af49dc3-5b57-434d-bd24-8e9b442afade" \ -H "Content-Type: application/json" \ -d '{ "title": "Q3 board summary", "collection": "col_9d2f", "tags": ["board", "q3"], "content": { "format": "markdown", "value": "# Q3\n\nRevenue is up 12% quarter on quarter." } }'

{ "id": "doc_xnr53sbj8jep", "object": "document", "status": "queued", "workspace": "ws_8f31c2a4", "title": "Q3 board summary", "tags": [ "board", "q3" ], "indexing": { "state": "pending", "estimated_seconds": 8 } }

curl -X GET "https://api.example.com/v{version}/tenants/{tenantId}/exports/exp%2F2026-08%2004?fields=id%2Csize&page=twelve&q=it's%20a%20%22quoted%22%20value%20%26%20more&include_deleted=yes" \ -H "X-Api-Key: $X_API_KEY" \ -H "X-Extremely-Long-Downstream-Correlation-Identifier: corr-8f31c2a49d7e6b5f0a3c2d1e8b7a6f5e4d3c2b1a0f9e8d7c6b5a4938271605f" \ -H "Content-Type: application/json" \ -d '{ "format": csv, "compress": true, }'