Extensions
Extensions API endpoints
/api/extensionsAuthorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Response Body
application/json
curl -X GET "http://localhost:3013/api/extensions"{
"extensions": [
{
"id": "string",
"name": "string",
"description": "string",
"runtime": "api",
"manifestJson": "string",
"contentHash": "string",
"version": 1,
"activeVersion": 1,
"enabled": true,
"priority": 0,
"configJson": "string",
"status": "disabled",
"consecutiveFailures": 0,
"lastError": "string",
"agentId": "string",
"createdByAgentId": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}/api/extensions/{id}Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthResponse Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:3013/api/extensions/string"{
"deleted": true,
"assets": {
"deleted": [
{
"kind": "script",
"name": "string"
}
],
"detached": [
{
"kind": "script",
"name": "string"
}
]
}
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}/api/extensions/{id}Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthResponse Body
application/json
application/json
curl -X GET "http://localhost:3013/api/extensions/string"{
"extension": {
"id": "string",
"name": "string",
"description": "string",
"runtime": "api",
"manifestJson": "string",
"contentHash": "string",
"version": 1,
"activeVersion": 1,
"enabled": true,
"priority": 0,
"configJson": "string",
"status": "disabled",
"consecutiveFailures": 0,
"lastError": "string",
"agentId": "string",
"createdByAgentId": "string",
"createdAt": "string",
"updatedAt": "string"
},
"manifest": {
"$schema": "string",
"name": "string",
"description": "string",
"version": "string",
"runtime": "api",
"assets": {
"hooks": "string",
"scripts": [
{
"name": "string",
"file": "string",
"description": "string",
"intent": "string"
}
],
"schedules": [
{
"name": "string",
"description": "string",
"script": "string",
"cronExpression": "string",
"intervalMs": 0,
"timezone": "string",
"args": {
"property1": null,
"property2": null
}
}
],
"workflows": [
{
"file": "string"
}
],
"skills": [
{
"dir": "string"
}
]
},
"homepage": "http://example.com",
"author": "string"
},
"files": {
"property1": "string",
"property2": "string"
}
}{
"error": "string",
"property1": null,
"property2": null
}/api/extensions/{id}Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:3013/api/extensions/string" \ -H "Content-Type: application/json" \ -d '{}'{
"extension": {
"id": "string",
"name": "string",
"description": "string",
"runtime": "api",
"manifestJson": "string",
"contentHash": "string",
"version": 1,
"activeVersion": 1,
"enabled": true,
"priority": 0,
"configJson": "string",
"status": "disabled",
"consecutiveFailures": 0,
"lastError": "string",
"agentId": "string",
"createdByAgentId": "string",
"createdAt": "string",
"updatedAt": "string"
}
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}/api/extensions/{id}/activate-versionAuthorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:3013/api/extensions/string/activate-version" \ -H "Content-Type: application/json" \ -d '{ "version": 1 }'{
"extension": {
"id": "string",
"name": "string",
"description": "string",
"runtime": "api",
"manifestJson": "string",
"contentHash": "string",
"version": 1,
"activeVersion": 1,
"enabled": true,
"priority": 0,
"configJson": "string",
"status": "disabled",
"consecutiveFailures": 0,
"lastError": "string",
"agentId": "string",
"createdByAgentId": "string",
"createdAt": "string",
"updatedAt": "string"
}
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}/api/extensions/{id}/disableAuthorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthResponse Body
application/json
application/json
application/json
curl -X POST "http://localhost:3013/api/extensions/string/disable"{
"extension": {
"id": "string",
"name": "string",
"description": "string",
"runtime": "api",
"manifestJson": "string",
"contentHash": "string",
"version": 1,
"activeVersion": 1,
"enabled": true,
"priority": 0,
"configJson": "string",
"status": "disabled",
"consecutiveFailures": 0,
"lastError": "string",
"agentId": "string",
"createdByAgentId": "string",
"createdAt": "string",
"updatedAt": "string"
}
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}/api/extensions/{id}/enableAuthorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthResponse Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:3013/api/extensions/string/enable"{
"extension": {
"id": "string",
"name": "string",
"description": "string",
"runtime": "api",
"manifestJson": "string",
"contentHash": "string",
"version": 1,
"activeVersion": 1,
"enabled": true,
"priority": 0,
"configJson": "string",
"status": "disabled",
"consecutiveFailures": 0,
"lastError": "string",
"agentId": "string",
"createdByAgentId": "string",
"createdAt": "string",
"updatedAt": "string"
}
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}/api/extensions/{id}/runsAuthorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthQuery Parameters
1 <= value <= 500Response Body
application/json
application/json
curl -X GET "http://localhost:3013/api/extensions/string/runs"{
"runs": [
{
"id": "string",
"extensionId": "string",
"version": 1,
"event": "string",
"action": "continue",
"durationMs": 0,
"message": "string",
"agentId": "string",
"subject": "string",
"createdAt": "string"
}
]
}{
"error": "string",
"property1": null,
"property2": null
}/api/extensions/{id}/versionsAuthorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
1 <= lengthResponse Body
application/json
application/json
curl -X GET "http://localhost:3013/api/extensions/string/versions"{
"versions": [
{
"id": "string",
"extensionId": "string",
"version": 1,
"manifestJson": "string",
"filesJson": "string",
"contentHash": "string",
"changedByAgentId": "string",
"changedAt": "string",
"changeReason": "string"
}
]
}{
"error": "string",
"property1": null,
"property2": null
}/api/extensions/catalogAuthorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Response Body
application/json
curl -X GET "http://localhost:3013/api/extensions/catalog"{
"extensions": [
{
"name": "string",
"description": "string",
"version": "string",
"manifestFile": "string",
"assets": {
"property1": 0,
"property2": 0
},
"readme": "string",
"installed": {
"id": "string",
"version": 0,
"enabled": true
}
}
]
}/api/extensions/installAuthorization
bearerAuth 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
application/json
curl -X POST "http://localhost:3013/api/extensions/install" \ -H "Content-Type: application/json" \ -d '{}'{
"extension": {
"id": "string",
"name": "string",
"description": "string",
"runtime": "api",
"manifestJson": "string",
"contentHash": "string",
"version": 1,
"activeVersion": 1,
"enabled": true,
"priority": 0,
"configJson": "string",
"status": "disabled",
"consecutiveFailures": 0,
"lastError": "string",
"agentId": "string",
"createdByAgentId": "string",
"createdAt": "string",
"updatedAt": "string"
},
"manifest": {
"$schema": "string",
"name": "string",
"description": "string",
"version": "string",
"runtime": "api",
"assets": {
"hooks": "string",
"scripts": [
{
"name": "string",
"file": "string",
"description": "string",
"intent": "string"
}
],
"schedules": [
{
"name": "string",
"description": "string",
"script": "string",
"cronExpression": "string",
"intervalMs": 0,
"timezone": "string",
"args": {
"property1": null,
"property2": null
}
}
],
"workflows": [
{
"file": "string"
}
],
"skills": [
{
"dir": "string"
}
]
},
"homepage": "http://example.com",
"author": "string"
},
"contentDeduped": true,
"assets": {
"created": [
{
"kind": "script",
"name": "string"
}
],
"updated": [
{
"kind": "script",
"name": "string"
}
],
"skipped": [
{
"kind": "script",
"name": "string"
}
],
"deleted": [
{
"kind": "script",
"name": "string"
}
],
"detached": [
{
"kind": "script",
"name": "string"
}
]
}
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}/api/extensions/type-defsAuthorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Response Body
curl -X GET "http://localhost:3013/api/extensions/type-defs"