API Overview
AiQarus provides a comprehensive GraphQL API for programmatic access.
Endpoint
https://api.aiqarus.com/graphqlAuthentication
API Keys
Generate API keys in Settings → API Keys:
curl -X POST https://api.aiqarus.com/graphql \
-H "Authorization: Bearer ak_your_api_key" \
-H "Content-Type: application/json" \
-d '{"query": "{ me { id name } }"}'JWT Tokens
For user authentication flows:
mutation Login($email: String!, $password: String!) {
login(email: $email, password: $password) {
accessToken
refreshToken
expiresAt
}
}Common Operations
List Agents
query ListAgents($projectId: ID) {
agents(projectId: $projectId) {
id
name
status
version
}
}Run Agent
mutation RunAgent($input: RunAgentInput!) {
runAgent(input: {
agentId: "agent_123"
input: { ... }
}) {
id
status
}
}Get Run Status
query GetRun($id: ID!) {
run(id: $id) {
id
status
steps {
number
status
duration
}
}
}Subscribe to Updates
subscription OnRunUpdate($runId: ID!) {
runUpdated(runId: $runId) {
id
status
currentStep
}
}Rate Limits
| Plan | Requests/min |
|---|---|
| Free | 10 |
| Starter | 100 |
| Pro | 1,000 |
| Enterprise | Custom |
Error Handling
GraphQL errors follow standard format:
{
"errors": [
{
"message": "Agent not found",
"extensions": {
"code": "NOT_FOUND"
}
}
]
}Documentation Coming Soon
Full API reference with all queries, mutations, and types is being developed.