Skip to Content
InvyteDocs

See what Invyte's agents may do

List where Invyte's agents hold a role in the organization (organization-wide, a Client or a Job) and, for each working agent (pipeline, delivery, communication, intake, sourcing, orchestrator, workflow), the modes set at each place: off, suggest, ask or auto per effect. Unset modes inherit the next wider place; unset everywhere is ask. Also whether each agent is paused, its monthly budget and this month's spend. Admins only.

POST
/operations/access.agentAccess

Authorization

bearer
headerAuthorizationBearer <API key or OAuth token>

An organization API key (ink_live_…, ADR-0124), or the OAuth access token a person's AI client gets from the Recruiter MCP sign-in. Only the Authorization header is accepted.

Header Parameters

Idempotency-Key?string

Makes a write safe to repeat: the same key and input return the first result. Required for agents' writes and for anything a person confirms.

Match^[A-Za-z0-9._:-]+$
Length8 <= length <= 128

Request Body

application/json
  1. body
input*
confirmation?string

The id from a confirm or awaiting_approval Outcome, sent with the same input and key to go ahead.

Response Body

Done. A replay of the same key and input omits output.

application/json
  1. response
status*unknown
output?
actionId*string
Example Request
curl -X POST 'https://www.invyte.ai/api/recruiter/v1/operations/access.agentAccess' \  -H 'Content-Type: application/json' \  -d '{  "input": {}}'
Example Response
{  "status": "done",  "output": {    "agentId": "invyte",    "assignments": [      {        "id": "string",        "roleId": "string",        "roleName": "string",        "scope": "organization",        "clientId": "string",        "clientName": "string",        "jobId": "string",        "jobTitle": "string",        "modes": {          "property1": {            "write": "off",            "outside": "off",            "destructive": "off"          },          "property2": {            "write": "off",            "outside": "off",            "destructive": "off"          }        }      }    ],    "agents": [      {        "agt": "pipeline",        "controls": {          "paused": true,          "pausedAt": "2019-08-24T14:15:22Z",          "monthlyBudgetUsd": 0,          "budget": {            "organization": {              "spentUsd": 0,              "capUsd": 0            },            "platform": {              "spentUsd": 0,              "capUsd": 0            },            "runUsd": 0          }        }      }    ]  },  "actionId": "string"}