GEgetspine
Runs

Create a canvas run

Submit a prompt to trigger an async canvas run. Agents orchestrate a DAG of blocks to satisfy the prompt; poll GET /v1/run/{run_id} until status becomes completed, partial, or failed.

post/v1/run

Request

  • Base URL
    https://api.getspine.ai
  • Auth
    API key in header X-API-KEY

Request body multipart/form-data

promptstring required

What you want the agents to do.

template'auto' | 'deep_research' | 'report' | 'slides' | 'memo' | 'excel' | 'app' | 'landing_page'

Preset that controls which block types agents are allowed to create.

blocksstring

JSON-encoded array of block types to override the template, e.g. ["document-block","table-block","image-block"]. Precedence: blocks > template > auto.

agent_instructionsstring

Behavioral guidance applied across all agent layers (tone, rigor, audience, citation requirements, etc.).

webhook_urlstring uri

Reserved for future webhook delivery — not yet honored.

filesstring[]

Optional file attachments. Images (PNG, JPEG, GIF, WEBP, SVG) become image-blocks; documents (PDF, DOCX, XLSX, CSV, TXT, MD, YAML, JSON, ZIP) become indexed file-blocks.

Example request

{
  "prompt": "Create a Q1 performance report with charts",
  "blocks": "[\"document-block\",\"table-block\",\"web-block\"]",
  "agent_instructions": "Write for a C-suite executive audience. Cite all sources."
}

Response

Run accepted. Poll poll_url for status and results.

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.