Home

Home dashboards

GET /v1/home/dashboards · homeDashboards

Account-authorized Home data. Reads do not start work. Layout writes use expected_revision and a request_id we keep, so the same request can be sent again after a lost response. Widget filters use project access plus the caller's GitHub connection. Packages contain no resource bindings or code. See docs/sdk/dashboard.md for validation and capacity limits.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Response

200 — Private, no-store result.

Type: HomeLibrary

Errors

Example

curl 'https://api.openagents.com/v1/home/dashboards' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN"

In the Rust SDK

• Home::library

Save home dashboards

PUT /v1/home/dashboards · saveHomeDashboards

Account-authorized Home data. Reads do not start work. Layout writes use expected_revision and a request_id we keep, so the same request can be sent again after a lost response. Widget filters use project access plus the caller's GitHub connection. Packages contain no resource bindings or code. See docs/sdk/dashboard.md for validation and capacity limits.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Request body

Content type: application/json

Type: HomeSave

Response

200 — Private, no-store result.

Type: HomeLibrary

Errors

Example

curl -X PUT 'https://api.openagents.com/v1/home/dashboards' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "request_id": "string",
  "expected_revision": 0,
  "library": {
    "revision": 0,
    "dashboards": [
      {
        "schema": "string",
        "id": "string",
        "revision": 0,
        "name": "string",
        "scope": {
          "project": "string",
          "repositories": [],
          "board": {
            "owner": "string",
            "number": 0
          }
        },
        "widgets": [
          {
            "id": "string",
            "kind": "string",
            "version": 0,
            "size": "compact"
          }
        ]
      }
    ]
  }
}'

In the Rust SDK

• Home::save

Home issue summary

POST /v1/home/issues · homeIssueSummary

Account-authorized Home data. Reads do not start work. Layout writes use expected_revision and a request_id we keep, so the same request can be sent again after a lost response. Widget filters use project access plus the caller's GitHub connection. Packages contain no resource bindings or code. See docs/sdk/dashboard.md for validation and capacity limits.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Request body

Content type: application/json

Type: HomeIssueFilter

Response

200 — Private, no-store result.

Type: HomeIssueSummary

Errors

Example

curl -X POST 'https://api.openagents.com/v1/home/issues' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "scope": {
    "project": "string",
    "repositories": [],
    "board": {
      "owner": "string",
      "number": 0
    }
  },
  "mine": false,
  "labels": [
    "string"
  ]
}'

In the Rust SDK

• Home::issues

Home projects

GET /v1/home/projects · homeProjects

Account-authorized Home data. Reads do not start work. Layout writes use expected_revision and a request_id we keep, so the same request can be sent again after a lost response. Widget filters use project access plus the caller's GitHub connection. Packages contain no resource bindings or code. See docs/sdk/dashboard.md for validation and capacity limits.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Response

200 — Private, no-store result.

Type: HomeProjects (array of object)

Errors

Example

curl 'https://api.openagents.com/v1/home/projects' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN"

In the Rust SDK

• Home::projects

Find home templates

GET /v1/home/templates · findHomeTemplates

Account-authorized Home data. Reads do not start work. Layout writes use expected_revision and a request_id we keep, so the same request can be sent again after a lost response. Widget filters use project access plus the caller's GitHub connection. Packages contain no resource bindings or code. See docs/sdk/dashboard.md for validation and capacity limits.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Parameters

Response

200 — Private, no-store result.

Type: HomeDirectory

Errors

Example

curl 'https://api.openagents.com/v1/home/templates' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN"

In the Rust SDK

• Home::directory
• Home::directory_by_author

Get home template

GET /v1/home/templates/{id} · getHomeTemplate

Account-authorized Home data. Reads do not start work. Layout writes use expected_revision and a request_id we keep, so the same request can be sent again after a lost response. Widget filters use project access plus the caller's GitHub connection. Packages contain no resource bindings or code. See docs/sdk/dashboard.md for validation and capacity limits.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Parameters

Response

200 — Private, no-store result.

Type: HomeListing

Errors

Example

curl 'https://api.openagents.com/v1/home/templates/{id}' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN"

In the Rust SDK

• Home::template

Publish home template

PUT /v1/home/templates/{id} · publishHomeTemplate

Account-authorized Home data. Reads do not start work. Layout writes use expected_revision and a request_id we keep, so the same request can be sent again after a lost response. Widget filters use project access plus the caller's GitHub connection. Packages contain no resource bindings or code. See docs/sdk/dashboard.md for validation and capacity limits.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Parameters

Request body

Content type: application/json

Type: HomePublish

Response

200 — Private, no-store result.

Type: HomeListing

Errors

Example

curl -X PUT 'https://api.openagents.com/v1/home/templates/{id}' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "request_id": "string",
  "expected_revision": 0,
  "package": {
    "schema": "string",
    "version": 0,
    "title": "string",
    "description": "string",
    "tags": [
      "string"
    ],
    "widgets": [
      {
        "id": "string",
        "kind": "string",
        "version": 0,
        "size": "compact"
      }
    ],
    "inputs": [
      "string"
    ],
    "hash": "string"
  },
  "visibility": "private"
}'

In the Rust SDK

• Home::publish

Remove home template

DELETE /v1/home/templates/{id} · removeHomeTemplate

Account-authorized Home data. Reads do not start work. Layout writes use expected_revision and a request_id we keep, so the same request can be sent again after a lost response. Widget filters use project access plus the caller's GitHub connection. Packages contain no resource bindings or code. See docs/sdk/dashboard.md for validation and capacity limits.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Parameters

Request body

Content type: application/json

Type: HomeRemove

Response

200 — Private, no-store result.

Type: HomeListing

Errors

Example

curl -X DELETE 'https://api.openagents.com/v1/home/templates/{id}' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "request_id": "string",
  "expected_revision": 0
}'

In the Rust SDK

• Home::remove

Report home template

POST /v1/home/templates/{id}/report · reportHomeTemplate

Account-authorized Home data. Reads do not start work. Layout writes use expected_revision and a request_id we keep, so the same request can be sent again after a lost response. Widget filters use project access plus the caller's GitHub connection. Packages contain no resource bindings or code. See docs/sdk/dashboard.md for validation and capacity limits.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Parameters

Request body

Content type: application/json

Type: HomeReport

Response

200 — Private, no-store result.

Type: HomeReportResult

Errors

Example

curl -X POST 'https://api.openagents.com/v1/home/templates/{id}/report' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "request_id": "string",
  "reason": "string"
}'

In the Rust SDK

• Home::report

Home work

GET /v1/home/work · homeWork

Account-authorized Home data. Reads do not start work. Layout writes use expected_revision and a request_id we keep, so the same request can be sent again after a lost response. Widget filters use project access plus the caller's GitHub connection. Packages contain no resource bindings or code. See docs/sdk/dashboard.md for validation and capacity limits.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Parameters

Response

200 — Private, no-store result.

Type: HomeWorkPage

Errors

Example

curl 'https://api.openagents.com/v1/home/work' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN"

In the Rust SDK

• Home::work