curl
curl -sS -X POST "https://gateway.orbit/api/v1/projects/4/task-definitions" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \
-H 'Content-Type: application/json' \
-d '{"name": "example", "title": "Build a feature", "brief": "Document and build it.", "parameters": [], "status": "backlog", "subtasks": [{"key": "docs", "title": "Write the docs", "kind": "agent"}]}'{
"data": {
"project_id": 123,
"name": "<string>",
"title": "<string>",
"brief": "<string>",
"parameters": [
{
"name": "<string>",
"type": "text",
"required": true,
"default": "<unknown>"
}
],
"status": "backlog",
"schedule": {},
"phases": [
{
"key": "<string>",
"title": "<string>",
"brief": "<string>",
"repeat": true
}
],
"subtasks": [
{
"key": "<string>",
"title": "<string>",
"kind": "<string>",
"brief": "<string>",
"phase": "<string>",
"deliverables": [
{
"id": "<string>",
"type": "file",
"description": "<string>",
"path": "<string>",
"change": "created",
"fails_on_base": true,
"command": "<string>",
"directory": "<string>",
"paths": [
"<string>"
]
}
],
"routes": {},
"implementer_model": "<string>",
"reviewer_model": "<string>",
"operation": "<string>",
"arguments": {},
"question": "<string>",
"options": [
"<string>"
],
"evidence": [
"<string>"
],
"min_probability": 123
}
]
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"data": {
"project_id": 123,
"name": "<string>",
"title": "<string>",
"brief": "<string>",
"parameters": [
{
"name": "<string>",
"type": "text",
"required": true,
"default": "<unknown>"
}
],
"status": "backlog",
"schedule": {},
"phases": [
{
"key": "<string>",
"title": "<string>",
"brief": "<string>",
"repeat": true
}
],
"subtasks": [
{
"key": "<string>",
"title": "<string>",
"kind": "<string>",
"brief": "<string>",
"phase": "<string>",
"deliverables": [
{
"id": "<string>",
"type": "file",
"description": "<string>",
"path": "<string>",
"change": "created",
"fails_on_base": true,
"command": "<string>",
"directory": "<string>",
"paths": [
"<string>"
]
}
],
"routes": {},
"implementer_model": "<string>",
"reviewer_model": "<string>",
"operation": "<string>",
"arguments": {},
"question": "<string>",
"options": [
"<string>"
],
"evidence": [
"<string>"
],
"min_probability": 123
}
]
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Tasks
tasks:definition:create
Stores a task definition for a Project. The body is the whole definition. Gateway access is required. The call does not start a task. An invalid definition returns tasks.definition_invalid (422), and details.rules names each failing rule and the subtask key. A name the Project already uses returns tasks.definition_exists (409). Returns extension.disabled while the tasks extension is off.
POST
/
api
/
v1
/
projects
/
{project}
/
task-definitions
curl
curl -sS -X POST "https://gateway.orbit/api/v1/projects/4/task-definitions" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \
-H 'Content-Type: application/json' \
-d '{"name": "example", "title": "Build a feature", "brief": "Document and build it.", "parameters": [], "status": "backlog", "subtasks": [{"key": "docs", "title": "Write the docs", "kind": "agent"}]}'{
"data": {
"project_id": 123,
"name": "<string>",
"title": "<string>",
"brief": "<string>",
"parameters": [
{
"name": "<string>",
"type": "text",
"required": true,
"default": "<unknown>"
}
],
"status": "backlog",
"schedule": {},
"phases": [
{
"key": "<string>",
"title": "<string>",
"brief": "<string>",
"repeat": true
}
],
"subtasks": [
{
"key": "<string>",
"title": "<string>",
"kind": "<string>",
"brief": "<string>",
"phase": "<string>",
"deliverables": [
{
"id": "<string>",
"type": "file",
"description": "<string>",
"path": "<string>",
"change": "created",
"fails_on_base": true,
"command": "<string>",
"directory": "<string>",
"paths": [
"<string>"
]
}
],
"routes": {},
"implementer_model": "<string>",
"reviewer_model": "<string>",
"operation": "<string>",
"arguments": {},
"question": "<string>",
"options": [
"<string>"
],
"evidence": [
"<string>"
],
"min_probability": 123
}
]
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"data": {
"project_id": 123,
"name": "<string>",
"title": "<string>",
"brief": "<string>",
"parameters": [
{
"name": "<string>",
"type": "text",
"required": true,
"default": "<unknown>"
}
],
"status": "backlog",
"schedule": {},
"phases": [
{
"key": "<string>",
"title": "<string>",
"brief": "<string>",
"repeat": true
}
],
"subtasks": [
{
"key": "<string>",
"title": "<string>",
"kind": "<string>",
"brief": "<string>",
"phase": "<string>",
"deliverables": [
{
"id": "<string>",
"type": "file",
"description": "<string>",
"path": "<string>",
"change": "created",
"fails_on_base": true,
"command": "<string>",
"directory": "<string>",
"paths": [
"<string>"
]
}
],
"routes": {},
"implementer_model": "<string>",
"reviewer_model": "<string>",
"operation": "<string>",
"arguments": {},
"question": "<string>",
"options": [
"<string>"
],
"evidence": [
"<string>"
],
"min_probability": 123
}
]
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Path Parameters
Numeric Project ID.
Required range:
x >= 1Body
application/json
Maximum string length:
63Maximum string length:
160Maximum string length:
8000Show child attributes
Show child attributes
Available options:
backlog, todo Minimum array length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes