agent-swarm.devOnboarding
Onboarding API endpoints
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Response Body
application/json
curl -X GET "http://localhost:3013/api/onboarding"{
"state": {
"version": 1,
"startedAt": "2019-08-24T14:15:22Z",
"currentStep": "connect",
"minimizedAt": "2019-08-24T14:15:22Z",
"dismissedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"autoCompleted": true,
"firstTaskId": "string",
"steps": {
"connect": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "api_key",
"errorClass": "auth"
},
"name": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "custom_name",
"errorClass": "auth"
},
"ai": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "claude_setup_token",
"errorClass": "auth"
},
"agents": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "cheap",
"errorClass": "auth"
},
"memory": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "openai",
"errorClass": "auth"
},
"integrations": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "slack",
"errorClass": "auth"
},
"first_task": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "suggestion",
"errorClass": "auth"
}
}
},
"signals": {
"providers": [
{
"provider": "claude",
"state": "unverified",
"workers": 0,
"verifiedWorkers": 0
}
],
"embeddings": {
"configured": true,
"dimensions": 0
},
"integrations": {
"slack": true,
"github": true,
"gitlab": true,
"linear": true,
"jira": true
},
"agents": {
"leadsOnline": 0,
"workersOnline": 0
},
"firstTask": {
"id": "string",
"status": "string"
}
}
}Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PUT "http://localhost:3013/api/onboarding" \ -H "Content-Type: application/json" \ -d '{ "action": "view", "step": "connect" }'{
"state": {
"version": 1,
"startedAt": "2019-08-24T14:15:22Z",
"currentStep": "connect",
"minimizedAt": "2019-08-24T14:15:22Z",
"dismissedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"autoCompleted": true,
"firstTaskId": "string",
"steps": {
"connect": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "api_key",
"errorClass": "auth"
},
"name": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "custom_name",
"errorClass": "auth"
},
"ai": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "claude_setup_token",
"errorClass": "auth"
},
"agents": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "cheap",
"errorClass": "auth"
},
"memory": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "openai",
"errorClass": "auth"
},
"integrations": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "slack",
"errorClass": "auth"
},
"first_task": {
"status": "todo",
"at": "2019-08-24T14:15:22Z",
"method": "suggestion",
"errorClass": "auth"
}
}
},
"signals": {
"providers": [
{
"provider": "claude",
"state": "unverified",
"workers": 0,
"verifiedWorkers": 0
}
],
"embeddings": {
"configured": true,
"dimensions": 0
},
"integrations": {
"slack": true,
"github": true,
"gitlab": true,
"linear": true,
"jira": true
},
"agents": {
"leadsOnline": 0,
"workersOnline": 0
},
"firstTask": {
"id": "string",
"status": "string"
}
}
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "http://localhost:3013/api/onboarding/memory" \ -H "Content-Type: application/json" \ -d '{ "preset": "openai" }'{
"ok": true,
"dimensions": 0,
"latencyMs": 0,
"error": "string",
"errorClass": "auth"
}{
"error": "string",
"property1": null,
"property2": null
}