API command line (syntic api)

Syntic Code is Syntic’s coding agent for the terminal. Its syntic api subcommands add a second job: managing your Syntic API resources from the same binary, without writing code. List models, upload files, run and collect batches, check usage, manage agents and keys, or send any raw request, all from a shell or a CI script.

When to use it

• Exploring the API: see which models you can use and try a request in seconds.
• Operations from CI: upload a file, submit a batch, wait for it and download results in a pipeline step.
• Quick admin tasks: list keys, check this month’s cost, find who has administrator rights.
• Debugging: send exactly the request your code sends and see the full response with headers.

Install and authenticate

Install Syntic Code as usual (see Syntic Code (CLI)). syntic api picks a credential in this order:

--base-url (or SYNTIC_BASE_URL) changes the host; the default is https://app.syntic.ai/v1.

Commands

Global flags

Exit status is 0 on success, 1 for an API error (the error envelope is printed to stderr), and 2 for a usage mistake.

Examples

# What can I use?
syntic api models list
 
# Nightly batch in CI
BATCH=$(syntic api batches create --input tickets.jsonl --json --jq .id)
syntic api batches wait "$BATCH"
syntic api batches results "$BATCH" -o labelled.jsonl
 
# This week's tokens per model
syntic api usage --since 7d --by model
 
# Raw request with headers
syntic api request POST /v1/chat/completions -i \
  -d '{"model": "Amara Quick", "stream": false, "messages": [{"role": "user", "content": "ping"}]}'

# syntic api models list
curl -sS https://app.syntic.ai/v1/models -H "Authorization: Bearer $SYNTIC_API_KEY"

// syntic api models list
import Syntic from '@syntic/sdk'
for await (const m of new Syntic().models.list()) console.log(m.id, m.context_window)

# syntic api models list
from syntic import Syntic
for m in Syntic().models.list():
    print(m.id, m.context_window)

Agent definitions as files

syntic api agents apply -f refund-desk.yaml creates the agent if no agent has that name, or updates it (making a new version) if one does. The file holds the same fields as the agent object:

name: refund-desk
model: Amara S1.2
instructions: |
  You handle refund requests for Acme Store.
  Look the order up before answering.
tools:
  - type: function
    function:
      name: lookup_order
      description: Fetch an order by its id.
      parameters:
        type: object
        properties:
          order_id: { type: string }
        required: [order_id]
limits:
  max_turns: 30

--dry-run prints the change without making it, so the command fits a review-then-apply workflow in CI.

Build notes

• The Syntic Code team builds this, not the platform team; it needs the endpoints to exist first.
• Reuse the CLI’s existing credential handling and output formatting; pagination and retries follow the same rules as the SDKs.
• Never print secrets: key and vault commands show prefixes and hints only.

Related

• Syntic Code (CLI)
• API reference overview
• Admin API keys