HTTP API: AI (Sovariq, app agents, model gateway)

Sovariq conversations and workspace, your project's app agents and their versions, knowledge bases, and the model gateway your app calls.

Updated Oct 24, 2026


Base URL	`https://<project-ref>.sovarias.in` — your project URL from Connect.
Keys	Send the project's key as `apikey`. Calls made for a signed-in user also send `Authorization: Bearer <access token>`.
Errors	A status code and `{"detail": …}` — a sentence, or `{code, message}` for errors your code may branch on (HTTP API).

#Endpoints

GET`/api/v1/sovariq/agents`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/agents" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/agents`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Body

namestringrequired: 2–60 characters
descriptionstringoptional: 0–500 characters
instructionsstringrequired: 20–8,000 characters
modelstring | nulloptional: 0–200 characters
native_toolsarray<string>optional: 0–200 items
custom_toolsarray<object>optional: 0–30 items
skillsarray<string>optional: 0–10 items
playbooksarray<object>optional: 0–5 items
mcp_server_idsarray<string>optional: 0–10 items
knowledge_basesarray<string>optional: 0–5 items
auto_approvearray<string>optional: 0–200 items
max_stepsintegeroptionaldefault 12: 1.0–30.0
max_tool_callsintegeroptionaldefault 24: 1.0–60.0
accessstringoptionaldefault members: pattern `^(members|app_users)$`
daily_runs_per_userintegeroptionaldefault 50: 0.0–10000.0
providerstringoptional: 0–40 characters
base_urlstring | nulloptional: 0–500 characters
api_keystring | nulloptional: 8–500 characters
routestring | nulloptional: 0–40 characters

Responses

201Created.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/agents" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/agents/builder`

What an agent can be built from in this project: Sovaria tools, skills, MCP servers, plan limits.

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/agents/builder" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/agents/draft`

Sovariq drafts an agent from a plain description: name, instructions and tools from this project's catalog.

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Body

goalstringrequired: 10–2,000 characters

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/agents/draft" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/agents/draft-tool`

Draft a custom tool's name, description and parameters with the model (the owner edits and saves).

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Body

kindstringrequired: pattern `^(sql_query|sql_write|function|http)$`
sqlstringoptional: 0–8,000 characters
functionstringoptional: 0–64 characters
urlstringoptional: 0–1,000 characters
methodstringoptionaldefault GET: 0–8 characters
goalstringoptional: 0–500 characters

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/agents/draft-tool" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/agents/provider-models`

Models a key can use, for the builder's model dropdown (the key is checked, not stored).

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Body

providerstringrequired: 0–40 characters
api_keystring | nulloptional: 8–500 characters
base_urlstring | nulloptional: 0–500 characters
agent_idstring | nulloptional: 0–64 characters

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/agents/provider-models" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

DELETE`/api/v1/sovariq/agents/{agent_id}`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

agent_idstringrequired

Responses

200Success.
401No valid session or key.

curl -s -X DELETE "$URL/api/v1/sovariq/agents/<agent_id>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

PUT`/api/v1/sovariq/agents/{agent_id}`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

agent_idstringrequired

Body

namestringrequired: 2–60 characters
descriptionstringoptional: 0–500 characters
instructionsstringrequired: 20–8,000 characters
modelstring | nulloptional: 0–200 characters
native_toolsarray<string>optional: 0–200 items
custom_toolsarray<object>optional: 0–30 items
skillsarray<string>optional: 0–10 items
playbooksarray<object>optional: 0–5 items
mcp_server_idsarray<string>optional: 0–10 items
knowledge_basesarray<string>optional: 0–5 items
auto_approvearray<string>optional: 0–200 items
max_stepsintegeroptionaldefault 12: 1.0–30.0
max_tool_callsintegeroptionaldefault 24: 1.0–60.0
accessstringoptionaldefault members: pattern `^(members|app_users)$`
daily_runs_per_userintegeroptionaldefault 50: 0.0–10000.0
providerstringoptional: 0–40 characters
base_urlstring | nulloptional: 0–500 characters
api_keystring | nulloptional: 8–500 characters
routestring | nulloptional: 0–40 characters

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X PUT "$URL/api/v1/sovariq/agents/<agent_id>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/agents/{agent_id}/runs`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

agent_idstringrequired

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/agents/<agent_id>/runs" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/agents/{agent_id}/runs`

Talk to a project agent (streamed): a new conversation, or the next turn of `thread_id. It acts with the caller's own permissions

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

agent_idstringrequired

Body

messagestringrequired: 1–20,000 characters
thread_idstring | nulloptional: Continue this conversation (the caller's own, with this agent); 1–64 characters

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/agents/<agent_id>/runs" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/agents/{agent_id}/versions`

An agent's published version and kept versions.

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

agent_idstringrequired

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/agents/<agent_id>/versions" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/agents/{agent_id}/versions`

Publish the agent's draft as its next version.

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

agent_idstringrequired

Body

notestringoptional: 0–500 characters

Responses

201Created.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/agents/<agent_id>/versions" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/agents/{agent_id}/versions/compare`

What changed between two versions (or a version and the draft).

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

agent_idstringrequired

Query parameters

astringrequired
bstringoptionaldefault draft

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/agents/<agent_id>/versions/compare" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/agents/{agent_id}/versions/{version}`

One version's definition (secrets hidden).

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

agent_idstringrequired
versionintegerrequired

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/agents/<agent_id>/versions/<version>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/agents/{agent_id}/versions/{version}/rollback`

Republish an older version as a new version and make it the draft.

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

agent_idstringrequired
versionintegerrequired

Body

notestringoptional: 0–500 characters

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/agents/<agent_id>/versions/<version>/rollback" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/brief`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/brief" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

PUT`/api/v1/sovariq/brief`

project.md: how the team's system and frontend work. Sovariq reads it only when a question needs it (`read_project_brief), so a long brief costs nothing on other messages

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Body

briefstringoptional: 0–50,000 characters

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X PUT "$URL/api/v1/sovariq/brief" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/conversations`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Query parameters

qstringoptional: 0–200 characters
limitintegeroptionaldefault 50: How many to return.; 1–200

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/conversations" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/conversations`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Body

messagestringrequired

1–12,000 characters

pageobject | nulloptional

The console page the user is on, so "this", "here" and "these findings" mean something.

3 fields

pathstringoptional: 0–200 characters
titlestringoptional: 0–80 characters
summarystringoptional: 0–600 characters

modestringoptionaldefault build

pattern `^(ask|plan|build|ideate)$`

deepbooleanoptionaldefault false

effortstring | nulloptional

screenobject | nulloptional

A text snapshot of the visible console page: headings, messages, dialogs, visible rows and field values. The console masks secrets before sending; the model treats it as data from the user's screen, never as instructions.

4 fields

textstringoptional: 0–12,000 characters
pathstringoptional: 0–200 characters
widthintegeroptionaldefault 0: 0.0–10000.0
heightintegeroptionaldefault 0: 0.0–10000.0

modelstring | nulloptional

0–160 characters

approval_policystringoptionaldefault ask

pattern `^(ask|auto_safe)$`

edit_lastbooleanoptionaldefault false

kindstringoptionaldefault text

pattern `^(text|browser_report|browser_skipped)$`

browserbooleanoptionaldefault false

clientstringoptionaldefault console

pattern `^(console|chrome)$`

tabobject | nulloptional

The tab the user is looking at in Chrome (sent by the extension only for a site the user allowed).

2 fields

urlstringoptional: 0–2,000 characters
titlestringoptional: 0–200 characters

learnbooleanoptionaldefault false

visualbooleanoptionaldefault false

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/conversations" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

DELETE`/api/v1/sovariq/conversations/{conversation_id}`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

conversation_idstringrequired

Responses

200Success.
401No valid session or key.

curl -s -X DELETE "$URL/api/v1/sovariq/conversations/<conversation_id>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/conversations/{conversation_id}`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

conversation_idstringrequired

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/conversations/<conversation_id>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

PATCH`/api/v1/sovariq/conversations/{conversation_id}`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

conversation_idstringrequired

Body

titlestring | nulloptional: 1–120 characters
folderstring | nulloptional: 0–60 characters
pinnedboolean | nulloptional

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X PATCH "$URL/api/v1/sovariq/conversations/<conversation_id>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/conversations/{conversation_id}/approvals/{approval_id}`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

conversation_idstringrequired
approval_idstringrequired

Body

approvebooleanrequired
op_hashstringrequired: 64–64 characters
alwaysbooleanoptionaldefault false

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/conversations/<conversation_id>/approvals/<approval_id>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/conversations/{conversation_id}/cancel`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

conversation_idstringrequired

Responses

200Success.
401No valid session or key.

curl -s -X POST "$URL/api/v1/sovariq/conversations/<conversation_id>/cancel" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/conversations/{conversation_id}/client-results`

Sovariq for Chrome answers the browser tool call the run paused on; the run continues (streamed).

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

conversation_idstringrequired

Body

tool_use_idstringrequired

1–128 characters

noncestringrequired

16–64 characters

okbooleanrequired

contentarray<object>optional

0–4 items

4 fields

typestringrequired: pattern `^(text|image)$`
textstringoptional: 0–60,000 characters
media_typestringoptional: 0–20 characters
datastringoptional: 0–2,100,000 characters

urlstringoptional

0–2,000 characters

reportobject | nulloptional

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/conversations/<conversation_id>/client-results" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/conversations/{conversation_id}/messages`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

conversation_idstringrequired

Body

messagestringrequired

1–12,000 characters

pageobject | nulloptional

The console page the user is on, so "this", "here" and "these findings" mean something.

3 fields

pathstringoptional: 0–200 characters
titlestringoptional: 0–80 characters
summarystringoptional: 0–600 characters

modestringoptionaldefault build

pattern `^(ask|plan|build|ideate)$`

deepbooleanoptionaldefault false

effortstring | nulloptional

screenobject | nulloptional

4 fields

textstringoptional: 0–12,000 characters
pathstringoptional: 0–200 characters
widthintegeroptionaldefault 0: 0.0–10000.0
heightintegeroptionaldefault 0: 0.0–10000.0

modelstring | nulloptional

0–160 characters

approval_policystringoptionaldefault ask

pattern `^(ask|auto_safe)$`

edit_lastbooleanoptionaldefault false

kindstringoptionaldefault text

pattern `^(text|browser_report|browser_skipped)$`

browserbooleanoptionaldefault false

clientstringoptionaldefault console

pattern `^(console|chrome)$`

tabobject | nulloptional

The tab the user is looking at in Chrome (sent by the extension only for a site the user allowed).

2 fields

urlstringoptional: 0–2,000 characters
titlestringoptional: 0–200 characters

learnbooleanoptionaldefault false

visualbooleanoptionaldefault false

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/conversations/<conversation_id>/messages" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/conversations/{conversation_id}/retry`

Retry. A run that stopped early (error, stop, budget, restart) continues from where it stopped, keeping the steps it already made; a finished reply is regenerated from the last user message.

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

conversation_idstringrequired

Responses

200Success.
401No valid session or key.

curl -s -X POST "$URL/api/v1/sovariq/conversations/<conversation_id>/retry" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/conversations/{conversation_id}/stream`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

conversation_idstringrequired

Query parameters

afterintegeroptionaldefault 0: 0–…

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/conversations/<conversation_id>/stream" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/gateway`

Model-gateway routes, the models they may use, plan limits and cache size.

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/gateway" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/gateway/cache/clear`

Drop every cached model response of the project.

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s -X POST "$URL/api/v1/sovariq/gateway/cache/clear" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

DELETE`/api/v1/sovariq/gateway/routes/{name}`

Delete a route (refused while an agent uses it).

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

namestringrequired

Responses

200Success.
401No valid session or key.

curl -s -X DELETE "$URL/api/v1/sovariq/gateway/routes/welcome" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

PUT`/api/v1/sovariq/gateway/routes/{name}`

Create or change a route: models in order (fallbacks), retry_on, cache {enabled, ttl_s}, access, daily_requests_per_user.

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

namestringrequired

Body

modelsarray<string>required: 1–11 items
retry_onarray<string> | nulloptional
cacheobject | nulloptional
max_output_tokensinteger | nulloptional
descriptionstringoptional: 0–200 characters
accessstringoptionaldefault members: pattern `^(members|app_users)$`
daily_requests_per_userintegeroptionaldefault 200: 0.0–100000.0

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X PUT "$URL/api/v1/sovariq/gateway/routes/welcome" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/gateway/usage`

Requests, errors, fallbacks, cache hits, tokens and latency per model and route.

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Query parameters

daysintegeroptionaldefault 7: 1–90

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/gateway/usage" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/gateway/{route}/complete`

One completion on a route: the first model that answers (fallbacks), or the cache.

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

routestringrequired

Body

systemstringoptional

0–20,000 characters

messagesarray<object>required

1–100 items

2 fields

rolestringrequired: pattern `^(user|assistant)$`
contentstringrequired: 1–50,000 characters

max_tokensintegeroptionaldefault 1024

1.0–16000.0

cachebooleanoptionaldefault true

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/gateway/<route>/complete" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/integrations`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/integrations" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/mcp-servers`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/mcp-servers" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/mcp-servers`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Body

namestringrequired: 2–31 characters
transportstringoptionaldefault http: pattern `^(http|stdio)$`
urlstringoptional: 0–2,048 characters
auth_header_namestringoptional: 0–64 characters
auth_header_valuestringoptional: 0–4,096 characters

Responses

201Created.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/mcp-servers" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

DELETE`/api/v1/sovariq/mcp-servers/{server_id}`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

server_idstringrequired

Responses

200Success.
401No valid session or key.

curl -s -X DELETE "$URL/api/v1/sovariq/mcp-servers/<server_id>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

PATCH`/api/v1/sovariq/mcp-servers/{server_id}`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

server_idstringrequired

Body

enabledbooleanrequired

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X PATCH "$URL/api/v1/sovariq/mcp-servers/<server_id>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/mcp-servers/{server_id}/test`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

server_idstringrequired

Responses

200Success.
401No valid session or key.

curl -s -X POST "$URL/api/v1/sovariq/mcp-servers/<server_id>/test" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/memory`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/memory" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

DELETE`/api/v1/sovariq/memory/{memory_id}`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

memory_idstringrequired

Responses

200Success.
401No valid session or key.

curl -s -X DELETE "$URL/api/v1/sovariq/memory/<memory_id>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/provider/test`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Query parameters

modelstringoptional: 0–160 characters

Responses

200Success.
401No valid session or key.

curl -s -X POST "$URL/api/v1/sovariq/provider/test" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/providers`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/providers" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

DELETE`/api/v1/sovariq/providers/{provider_id}`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

provider_idstringrequired

Responses

200Success.
401No valid session or key.

curl -s -X DELETE "$URL/api/v1/sovariq/providers/<provider-id>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

PUT`/api/v1/sovariq/providers/{provider_id}`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

provider_idstringrequired

Body

api_keystringoptional: 0–500 characters
base_urlstringoptional: 0–500 characters
modelsarray<string>optional: 0–40 items

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X PUT "$URL/api/v1/sovariq/providers/<provider-id>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/providers/{provider_id}/models`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

provider_idstringrequired

Responses

200Success.
401No valid session or key.

curl -s -X POST "$URL/api/v1/sovariq/providers/<provider-id>/models" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/rules`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/rules" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

PUT`/api/v1/sovariq/rules`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Body

rulesstringoptional: 0–2,000 characters

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X PUT "$URL/api/v1/sovariq/rules" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/sites`

The team's own sites Sovariq may open with Sovariq for Chrome, and the ones it won't (with why).

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/sites" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

PUT`/api/v1/sovariq/sites`

Set the project's sites (admins). Unblocking a site lets it be added again.

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Body

allowedarray<string>optional: 0–20 items
unblockarray<string>optional: 0–50 items

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X PUT "$URL/api/v1/sovariq/sites" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/skills`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/skills" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/status`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/status" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/tools`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/tools" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

GET`/api/v1/sovariq/workspace/sql-snippets`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Responses

200Success.
401No valid session or key.

curl -s "$URL/api/v1/sovariq/workspace/sql-snippets" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/workspace/sql-snippets`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Body

namestring | nulloptional: 0–200 characters
sqlstring | nulloptional: 0–100,000 characters
folderstring | nulloptional: 0–80 characters
visibilitystring | nulloptional: pattern `^(private|team)$`

Responses

201Created.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/workspace/sql-snippets" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

DELETE`/api/v1/sovariq/workspace/sql-snippets/{snippet_id}`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

snippet_idstringrequired

Responses

200Success.
401No valid session or key.

curl -s -X DELETE "$URL/api/v1/sovariq/workspace/sql-snippets/<snippet_id>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

PUT`/api/v1/sovariq/workspace/sql-snippets/{snippet_id}`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

snippet_idstringrequired

Body

namestring | nulloptional: 0–200 characters
sqlstring | nulloptional: 0–100,000 characters
folderstring | nulloptional: 0–80 characters
visibilitystring | nulloptional: pattern `^(private|team)$`

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X PUT "$URL/api/v1/sovariq/workspace/sql-snippets/<snippet_id>" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/workspace/sql-snippets/{snippet_id}/favorite`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

snippet_idstringrequired

Body

onbooleanoptionaldefault true

Responses

200Success.
401No valid session or key.
422The body is missing a required field or has a field of the wrong type.

curl -s -X POST "$URL/api/v1/sovariq/workspace/sql-snippets/<snippet_id>/favorite" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

POST`/api/v1/sovariq/workspace/sql-snippets/{snippet_id}/ran`

Who: A project team member's session (the console, or a token from sov login) as Authorization: Bearer <token>. The member's role must allow the action.

Path parameters

snippet_idstringrequired

Responses

204Success, with no body.
401No valid session or key.

curl -s -X POST "$URL/api/v1/sovariq/workspace/sql-snippets/<snippet_id>/ran" \
  -H "apikey: $ANON_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

HTTP API: AI (Sovariq, app agents, model gateway)

#Endpoints

#GET/api/v1/sovariq/agents

Responses

#POST/api/v1/sovariq/agents

Body

Responses

#GET/api/v1/sovariq/agents/builder

Responses

#POST/api/v1/sovariq/agents/draft

Body

Responses

#POST/api/v1/sovariq/agents/draft-tool

Body

Responses

#POST/api/v1/sovariq/agents/provider-models

Body

Responses

#DELETE/api/v1/sovariq/agents/{agent_id}

Path parameters

Responses

#PUT/api/v1/sovariq/agents/{agent_id}

Path parameters

Body

Responses

#GET/api/v1/sovariq/agents/{agent_id}/runs

Path parameters

Responses

#POST/api/v1/sovariq/agents/{agent_id}/runs

Path parameters

Body

Responses

#GET/api/v1/sovariq/agents/{agent_id}/versions

Path parameters

Responses

#POST/api/v1/sovariq/agents/{agent_id}/versions

Path parameters

Body

Responses

#GET/api/v1/sovariq/agents/{agent_id}/versions/compare

Path parameters

Query parameters

Responses

#GET/api/v1/sovariq/agents/{agent_id}/versions/{version}

Path parameters

Responses

#POST/api/v1/sovariq/agents/{agent_id}/versions/{version}/rollback

Path parameters

Body

Responses

#GET/api/v1/sovariq/brief

Responses

#PUT/api/v1/sovariq/brief

Body

Responses

#GET/api/v1/sovariq/conversations

Query parameters

Responses

#POST/api/v1/sovariq/conversations

Body

Responses

#DELETE/api/v1/sovariq/conversations/{conversation_id}

Path parameters

Responses

#GET/api/v1/sovariq/conversations/{conversation_id}

Path parameters

Responses

#PATCH/api/v1/sovariq/conversations/{conversation_id}

Path parameters

Body

Responses

#POST/api/v1/sovariq/conversations/{conversation_id}/approvals/{approval_id}

Path parameters

Body

Responses

#POST/api/v1/sovariq/conversations/{conversation_id}/cancel

Path parameters

Responses

#POST/api/v1/sovariq/conversations/{conversation_id}/client-results

Path parameters

GET`/api/v1/sovariq/agents`

POST`/api/v1/sovariq/agents`

GET`/api/v1/sovariq/agents/builder`

POST`/api/v1/sovariq/agents/draft`

POST`/api/v1/sovariq/agents/draft-tool`

POST`/api/v1/sovariq/agents/provider-models`

DELETE`/api/v1/sovariq/agents/{agent_id}`

PUT`/api/v1/sovariq/agents/{agent_id}`

GET`/api/v1/sovariq/agents/{agent_id}/runs`

POST`/api/v1/sovariq/agents/{agent_id}/runs`

GET`/api/v1/sovariq/agents/{agent_id}/versions`

POST`/api/v1/sovariq/agents/{agent_id}/versions`

GET`/api/v1/sovariq/agents/{agent_id}/versions/compare`

GET`/api/v1/sovariq/agents/{agent_id}/versions/{version}`

POST`/api/v1/sovariq/agents/{agent_id}/versions/{version}/rollback`

GET`/api/v1/sovariq/brief`

PUT`/api/v1/sovariq/brief`

GET`/api/v1/sovariq/conversations`

POST`/api/v1/sovariq/conversations`

DELETE`/api/v1/sovariq/conversations/{conversation_id}`

GET`/api/v1/sovariq/conversations/{conversation_id}`

PATCH`/api/v1/sovariq/conversations/{conversation_id}`

POST`/api/v1/sovariq/conversations/{conversation_id}/approvals/{approval_id}`

POST`/api/v1/sovariq/conversations/{conversation_id}/cancel`

POST`/api/v1/sovariq/conversations/{conversation_id}/client-results`

POST`/api/v1/sovariq/conversations/{conversation_id}/messages`

POST`/api/v1/sovariq/conversations/{conversation_id}/retry`

GET`/api/v1/sovariq/conversations/{conversation_id}/stream`

GET`/api/v1/sovariq/gateway`

POST`/api/v1/sovariq/gateway/cache/clear`

DELETE`/api/v1/sovariq/gateway/routes/{name}`

PUT`/api/v1/sovariq/gateway/routes/{name}`

GET`/api/v1/sovariq/gateway/usage`

POST`/api/v1/sovariq/gateway/{route}/complete`

GET`/api/v1/sovariq/integrations`

GET`/api/v1/sovariq/mcp-servers`

POST`/api/v1/sovariq/mcp-servers`

DELETE`/api/v1/sovariq/mcp-servers/{server_id}`

PATCH`/api/v1/sovariq/mcp-servers/{server_id}`

POST`/api/v1/sovariq/mcp-servers/{server_id}/test`

GET`/api/v1/sovariq/memory`

DELETE`/api/v1/sovariq/memory/{memory_id}`

POST`/api/v1/sovariq/provider/test`

GET`/api/v1/sovariq/providers`

DELETE`/api/v1/sovariq/providers/{provider_id}`

PUT`/api/v1/sovariq/providers/{provider_id}`

POST`/api/v1/sovariq/providers/{provider_id}/models`

GET`/api/v1/sovariq/rules`