Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getspine.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Spine API lets you run canvas-based research and agent workflows programmatically. Submit a prompt, pick a template (or custom blocks), and poll for the synthesized result plus downloadable artifacts.

​
1. Get an API key

Sign up at the developer portal — you get $5 of free credits immediately (no card required) to try the API end-to-end. Pricing is simple pay-as-you-go: $1 = 1,000 credits, no subscription. Create a key from the keys page. Keys look like: 
sk_spine_...
Keys are shown only once at creation — store them somewhere safe. See Authentication for rotation and revocation.

​
2. Make your first request

curl -X POST https://api.getspine.ai/v1/run \
  -H "X-API-KEY: sk_spine_..." \
  -F "prompt=What is the current state of AI regulation in the EU?"
Try it interactively on the Create a run page.

​
3. Poll for results

The API returns a run_id immediately. Poll the status endpoint until the run completes: 
curl https://api.getspine.ai/v1/run/<run_id> \
  -H "X-API-KEY: sk_spine_..."
Runs average 10–20 minutes; complex research can take up to 2 hours. Poll every 15–30 seconds.

​
4. Read the result

When status becomes completed, the response includes:
  • result.final_output — the synthesized answer
  • result.artifacts — downloadable files (docx, xlsx, pptx, html, png, …)
  • metadata.credits_consumed — credits used for this run

​
Next steps

Authentication

Manage, rotate, and secure your API keys.

Canvases and runs

How runs, canvases, and blocks fit together.

Templates

Preset block configurations for common workflows.

Endpoints

Full endpoint reference with try-it panels.