API Tara: authoring
Author resources on the Portal (wizard, new versions)
This page is generated from
openapi.yamlbynpm run gen, so do not edit it by hand. Authentication is described on the overview page.
/v1/drafts/scaffoldScaffold a starter package for a new resource (wizard on the Portal)
Checks the type, name (including duplicates) and permission on the organization, then returns the starter file set. Nothing is saved.
Body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
kind | skill | agent | kit | prompt | harness | yes | |
name | string | yes | |
org | string | yes | aiforge or the submitter's organization slug: a reviewed resource. Empty: a personal resource in the community channel (no review, no kit) |
displayName | string | yes | |
description | string | yes | |
roles | string[] | ||
keywords | string[] | ||
authorName | string | yes | |
authorEmail | string | ||
owners | string[] | yes | Emails of the people responsible |
dependencies | object[] |
Responses
| Code | Description | Type |
|---|---|---|
| 200 | Starter file set | application/json · object |
| 400 | Invalid input | application/problem+json · object |
| 401 | Not signed in | application/problem+json · object |
| 403 | Forbidden | application/problem+json · object |
| 409 | Conflict | application/problem+json · object |
Example response
json
{
"files": [
{
"path": "agents/ba.md",
"content": "string",
"encoding": "utf8",
"executable": false
}
]
}Call with curl
bash
curl -X POST "https://tara.phillipcli.cloud/v1/drafts/scaffold" \
-H "Authorization: Bearer $TARA_TOKEN" \
-H "Content-Type: application/json" \
-d '{"kind":"skill","name":"agent-java-review","org":"acme","displayName":"string","description":"string","authorName":"string","owners":["string"]}'/v1/drafts/releaseSet a new version and CHANGELOG entry in the file set being edited
Only transforms the file set (plugin.json, CHANGELOG.md) and returns it; nothing is saved. Submit it through /v1/submissions like an uploaded package.
Body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
files | object[] | yes | |
version | string | yes | |
changelog | string | yes | CHANGELOG entry content (Markdown) |
Responses
| Code | Description | Type |
|---|---|---|
| 200 | File set with the version applied | application/json · object |
| 400 | Invalid input | application/problem+json · object |
| 401 | Not signed in | application/problem+json · object |
Example response
json
{
"files": [
{
"path": "agents/ba.md",
"content": "string",
"encoding": "utf8",
"executable": false
}
]
}Call with curl
bash
curl -X POST "https://tara.phillipcli.cloud/v1/drafts/release" \
-H "Authorization: Bearer $TARA_TOKEN" \
-H "Content-Type: application/json" \
-d '{"files":[{"path":"agents/ba.md","content":"string","encoding":"utf8","executable":false}],"version":"1.1.0","changelog":"string"}'/v1/versions/{id}/sourceAll files of a version, as a starting point for a new version
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Responses
| Code | Description | Type |
|---|---|---|
| 200 | File set and suggested version number | application/json · object |
| 401 | Not signed in | application/problem+json · object |
| 403 | Forbidden | application/problem+json · object |
| 404 | Not found | application/problem+json · object |
Example response
json
{
"id": "string",
"name": "string",
"kind": "skill",
"org": "string",
"version": "string",
"displayName": "string",
"state": "submitted",
"files": [
{
"path": "agents/ba.md",
"content": "string",
"encoding": "utf8",
"executable": false
}
],
"suggestions": {
"current": "string",
"patch": "string",
"minor": "string",
"major": "string"
}
}Call with curl
bash
curl "https://tara.phillipcli.cloud/v1/versions/<id>/source" \
-H "Authorization: Bearer $TARA_TOKEN"