Agents
Create an agent
POST /v1/agents- Permission
write:configs- Tokens
- API key, CLI user token
Create an API-managed agent. It is live immediately.
{
}
{
}
import os
from ellipsis import Ellipsis
from ellipsis import models
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
request = models.CreateAgentRequest.model_validate(
{
"agent": {
"ellipsis": {
"kind": "agent",
"name": "check-tests",
"version": "v1",
"enabled": True,
"metadata": {
"labels": [],
"annotations": {}
}
},
"session": {
"claude_code": {
"prompt": "Run the tests and report failures."
},
"environment": "api-environment",
"budget": {
"session": 3
},
"permissions": {
"github": {},
"ellipsis": True
},
"skills": []
}
}
}
)
result = client.agents.create(request.agent)
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const request: Parameters<typeof client.agents.create>[0] = {
"agent": {
"ellipsis": {
"kind": "agent",
"name": "check-tests",
"version": "v1",
"enabled": true,
"metadata": {
"labels": [],
"annotations": {}
}
},
"session": {
"claude_code": {
"prompt": "Run the tests and report failures."
},
"environment": "api-environment",
"budget": {
"session": 3
},
"permissions": {
"github": {},
"ellipsis": true
},
"skills": []
}
}
};
const result = await client.agents.create(request);
console.log(result);curl -X POST "https://api.ellipsis.dev/v1/agents" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"agent": {
"ellipsis": {
"kind": "agent",
"name": "check-tests",
"version": "v1",
"enabled": true,
"metadata": {
"labels": [],
"annotations": {}
}
},
"session": {
"claude_code": {
"prompt": "Run the tests and report failures."
},
"environment": "api-environment",
"budget": {
"session": 3
},
"permissions": {
"github": {},
"ellipsis": true
},
"skills": []
}
}
}'Request
agentAgentConfig-Inputrequired
The agent's definition, in the same schema as a YAML file under .ellipsis/.
Response
agentAgentrequired
The agent.