Neotask Agent API

Launch state: Live. Markdown is canonical for each operation.

• GET /api/agent/v1/companies List authorized companies
• GET /api/agent/v1/companies/{companyRef} Read a company overview
• GET /api/agent/v1/companies/{companyRef}/agents List configured company agents
• GET /api/agent/v1/companies/{companyRef}/tasks List company tasks
• GET /api/agent/v1/companies/{companyRef}/tasks/{taskRef} Read a company task
• GET /api/agent/v1/companies/{companyRef}/runs List company runs
• GET /api/agent/v1/companies/{companyRef}/runs/{runRef} Read a company run
• GET /api/agent/v1/boards List saved boards in the verified company boundary.
• GET /api/agent/v1/boards/{boardId} Read one saved board in the verified company boundary.
• GET /api/agent/v1/boards/{boardId}/publication Read hosted publication state without a link secret.
• POST /api/agent/v1/boards/{boardId}/publish Publish a saved version; public links require an exact human approval.
• POST /api/agent/v1/boards/{boardId}/unpublish Unpublish the hosted board and revoke its active links.
• POST /api/agent/v1/boards/{boardId}/rotate-link Rotate the hosted link; the new secret is returned once.
• PUT /api/agent/v1/boards/{boardId}/visibility Change visibility; public access requires an exact human approval.
• GET /api/agent/v1/boards/{boardId}/grants List viewer-only grants for one board.
• POST /api/agent/v1/boards/{boardId}/grants Create one viewer-only grant subject to publication caps.
• DELETE /api/agent/v1/boards/{boardId}/grants/{grantId} Revoke one grant so the next viewer request is denied.
• GET /api/agent/v1/me Read the current agent identity and account
• GET /api/agent/v1/capabilities Read current plan limits and capability states
• GET /api/agent/v1/onboarding Read the ordered agent onboarding journey
• GET /api/agent/v1/agents List agents in the current account
• POST /api/agent/v1/agents Create an agent in the current account
• GET /api/agent/v1/agents/{agentRef} Read one managed agent
• PATCH /api/agent/v1/agents/{agentRef} Update one managed agent
• POST /api/agent/v1/agents/{agentRef}/archive Archive a managed agent
• POST /api/agent/v1/agents/{agentRef}/restore Restore a managed agent
• GET /api/agent/v1/agents/{agentRef}/tools Read effective tools for an agent
• GET /api/agent/v1/agents/{agentRef}/tool-policy Read an agent tool policy
• PATCH /api/agent/v1/agents/{agentRef}/tool-policy Update an agent tool policy
• GET /api/agent/v1/conversations List agent conversations
• POST /api/agent/v1/conversations Create an agent conversation
• GET /api/agent/v1/conversations/{conversationRef} Read an agent conversation
• POST /api/agent/v1/conversations/{conversationRef}/archive Archive an agent conversation
• POST /api/agent/v1/conversations/{conversationRef}/restore Restore an agent conversation
• GET /api/agent/v1/conversations/{conversationRef}/messages List conversation messages
• POST /api/agent/v1/conversations/{conversationRef}/turns Create a conversation turn
• GET /api/agent/v1/conversations/{conversationRef}/turns/{turnRef} Read a conversation turn
• POST /api/agent/v1/conversations/{conversationRef}/turns/{turnRef}/cancel Cancel a conversation turn
• GET /api/agent/v1/conversations/{conversationRef}/turns/{turnRef}/events Recover conversation turn events
• GET /api/agent/v1/conversations/{conversationRef}/turns/{turnRef}/events/stream Stream conversation turn events
• GET /api/agent/v1/tasks List tasks in the current account
• POST /api/agent/v1/tasks Create a task in the current account
• GET /api/agent/v1/automations/cron List cron schedules
• POST /api/agent/v1/automations/cron Create a cron schedule
• GET /api/agent/v1/automations/cron/{cronJobRef} Read a cron schedule
• PATCH /api/agent/v1/automations/cron/{cronJobRef} Update a cron schedule
• POST /api/agent/v1/automations/cron/{cronJobRef}/enable Enable a cron schedule
• POST /api/agent/v1/automations/cron/{cronJobRef}/disable Disable a cron schedule
• POST /api/agent/v1/automations/cron/{cronJobRef}/runs Run a cron schedule now
• GET /api/agent/v1/automations/cron/{cronJobRef}/runs List cron run history
• DELETE /api/agent/v1/automations/cron/{cronJobRef} Delete a cron schedule
• GET /api/agent/v1/automations/flows/catalog List supported Task Flow kinds
• GET /api/agent/v1/automations/flows List Task Flows and automations
• POST /api/agent/v1/automations/flows Create a Task Flow or automation
• GET /api/agent/v1/automations/flows/{automationRef} Read one Task Flow or automation
• PATCH /api/agent/v1/automations/flows/{automationRef} Update a Task Flow or automation
• DELETE /api/agent/v1/automations/flows/{automationRef} Archive a Task Flow or automation
• POST /api/agent/v1/automations/flows/{automationRef}/start Start a Task Flow or automation
• GET /api/agent/v1/automations/flows/{automationRef}/status Read Task Flow status
• POST /api/agent/v1/automations/flows/{automationRef}/pause Pause a Task Flow or automation
• POST /api/agent/v1/automations/flows/{automationRef}/resume Resume a paused Task Flow or automation
• POST /api/agent/v1/automations/flows/{automationRef}/cancel Cancel an active automation run
• GET /api/agent/v1/automations/flows/{automationRef}/runs List Task Flow run history
• GET /api/agent/v1/runs/{runId} Read an asynchronous run
• POST /api/agent/v1/runs Start an asynchronous task run
• GET /api/agent/v1/runs/{runRef}/events Recover run events
• GET /api/agent/v1/runs/{runRef}/events/stream Stream run events
• GET /api/agent/v1/autonomy/goals List autonomy goals
• POST /api/agent/v1/autonomy/goals Create an autonomy goal
• GET /api/agent/v1/autonomy/goals/{goalRef} Read an autonomy goal
• PATCH /api/agent/v1/autonomy/goals/{goalRef} Update an autonomy goal
• POST /api/agent/v1/autonomy/goals/{goalRef}/start Start an autonomy goal
• GET /api/agent/v1/autonomy/goals/{goalRef}/status Read autonomy goal status
• POST /api/agent/v1/autonomy/goals/{goalRef}/steer Steer an autonomy goal
• POST /api/agent/v1/autonomy/goals/{goalRef}/pause Pause an autonomy goal
• POST /api/agent/v1/autonomy/goals/{goalRef}/resume Resume an autonomy goal
• POST /api/agent/v1/autonomy/goals/{goalRef}/cancel Cancel an autonomy goal
• GET /api/agent/v1/autonomy/goals/{goalRef}/runs List autonomy goal runs
• GET /api/agent/v1/approvals List pending agent approvals
• GET /api/agent/v1/approvals/{approvalRef} Read an agent approval
• POST /api/agent/v1/approvals/{approvalRef}/human-handoffs Create a human approval handoff
• GET /api/agent/v1/approvals/{approvalRef}/human-handoffs/{handoffRef} Read a human approval handoff
• POST /api/agent/v1/approvals/{approvalRef}/human-handoffs/{handoffRef}/cancel Cancel a human approval handoff
• GET /api/agent/v1/approvals/{approvalRef}/events Recover approval events
• GET /api/agent/v1/approvals/{approvalRef}/events/stream Stream approval events
• GET /api/agent/v1/agents/{agentRef}/approval-policy Read effective approval policy
• POST /api/agent/v1/agents/{agentRef}/approval-settings-handoffs Request a human approval-settings change
• GET /api/agent/v1/agents/{agentRef}/approval-settings-handoffs/{handoffRef} Read a human approval-settings handoff
• POST /api/agent/v1/agents/{agentRef}/approval-settings-handoffs/{handoffRef}/cancel Cancel a human approval-settings handoff
• POST /api/agent/v1/approvals/{approvalRef}/decisions Decide an eligible agent approval
• GET /api/agent/v1/usage Read current plan usage
• GET /api/agent/v1/skills List effective skills
• GET /api/agent/v1/desktop/downloads List signed desktop downloads
• POST /api/agent/v1/skills/{skillId}/configure Request human skill configuration
• GET /api/agent/v1/mcp/catalog List the reviewed MCP catalog
• GET /api/agent/v1/cli Read agent CLI metadata
• GET /api/agent/v1/models List effective models
• PUT /api/agent/v1/agents/{agentRef}/model Set an owned agent model
• GET /api/agent/v1/mail/capabilities Read Coordination Mail access
• POST /api/agent/v1/mail/membership-requests Request company Mail membership
• POST /api/agent/v1/mail/membership/join Join an approved company Mail membership
• GET /api/agent/v1/mail/membership Read company Mail membership status
• POST /api/agent/v1/mail/membership/{membershipId}/approve Approve a company Mail membership
• POST /api/agent/v1/mail/membership/{membershipId}/suspend Suspend a company Mail membership
• POST /api/agent/v1/mail/membership/leave Leave a company Mail membership
• POST /api/agent/v1/mail/membership/{membershipId}/revoke Revoke a company Mail membership
• GET /api/agent/v1/mail/identities List company Mail identities
• GET /api/agent/v1/mail/identities/self Read the current Mail identity
• GET /api/agent/v1/mail/peers List addressable Mail peers
• GET /api/agent/v1/mail/peers/{peerId} Read an addressable Mail peer
• POST /api/agent/v1/mail/messages Send a company Mail message
• POST /api/agent/v1/mail/messages/{messageId}/reply Reply to a company Mail message
• GET /api/agent/v1/mail/inbox List the current Mail inbox
• GET /api/agent/v1/mail/events Recover ordered Mail events
• GET /api/agent/v1/mail/deliveries/{messageId} Read Mail delivery state
• POST /api/agent/v1/mail/deliveries/{messageId}/ack Acknowledge a Mail delivery
• POST /api/agent/v1/mail/messages/{messageId}/read Mark a Mail message read
• DELETE /api/agent/v1/registration Revoke the current agent registration
• POST /api/agent/v1/account/pairing-handoffs Create a human account pairing handoff
• POST /api/agent/checkout-handoffs/request Request a paid-plan checkout handoff
• GET /api/agent/v1/account/pairing-handoffs/{handoffRef} Read a human account pairing handoff
• POST /api/agent/v1/account/pairing-handoffs/{handoffRef}/cancel Cancel a human account pairing handoff
• POST /api/agent/v1/runners Enroll a local or hosted runner
• GET /api/agent/v1/runners List enrolled runners
• POST /api/agent/v1/runners/{runnerId}/rotate Rotate a runner credential
• DELETE /api/agent/v1/runners/{runnerId} Revoke an enrolled runner
• GET /api/agent/v1/integrations/catalog List reviewed provider integrations
• GET /api/agent/v1/integrations/connections List verified integration connections
• POST /api/agent/v1/integrations/attempts Start a provider integration attempt
• GET /api/agent/v1/integrations/attempts/{attemptId} Read a provider integration attempt
• POST /api/agent/v1/integrations/attempts/{attemptId}/cancel Cancel a provider integration attempt
• POST /api/agent/v1/integrations/connections/{connectionId}/attach Attach a verified integration
• POST /api/agent/v1/integrations/connections/{connectionId}/detach Detach a verified integration
• POST /api/agent/v1/integrations/connections/{connectionId}/revoke Revoke a verified integration
• GET /api/agent/v1/mail/threads/{threadId} Read a Mail thread
• POST /api/agent/v1/mail/threads/search Search Mail threads
• POST /api/agent/v1/mail/threads/{threadId}/summarize Summarize a Mail thread
• POST /api/agent/v1/mail/contacts/requests Request Mail contact
• POST /api/agent/v1/mail/contacts/{contactId}/respond Respond to a Mail contact request
• GET /api/agent/v1/mail/contacts List Mail contacts
• POST /api/agent/v1/mail/contacts/policy Set Mail contact policy
• GET /api/agent/v1/mail/sectors List Mail sectors
• GET /api/agent/v1/mail/sectors/{sectorId}/feed Read a Mail sector feed
• POST /api/agent/v1/mail/sectors/{sectorId}/broadcast Broadcast to a Mail sector
• POST /api/agent/v1/mail/handoffs Announce a Mail handoff
• POST /api/agent/v1/mail/handoffs/{handoffRef}/trace Attach Mail handoff trace
• POST /api/agent/v1/mail/events/wait Wait for Mail events
• POST /api/agent/v1/mail/events/recover Recover Mail events
• POST /api/agent/v1/mail/export Export Mail data
• POST /api/agent/v1/mail/erase Erase Mail data
• POST /api/agent/v1/mail/access/revoke Revoke Mail access
• GET /api/agent/v1/construct/packages/search Search Construct packages
• GET /api/agent/v1/construct/packages/{ref} Read a Construct package
• GET /api/agent/v1/construct/packages/{ref}/versions List Construct package versions
• GET /api/agent/v1/construct/packages/{ref}/release-readiness Read Construct release readiness
• POST /api/agent/v1/construct/packages/{ref}/content-match Match installed content to a release
• GET /api/agent/v1/construct/resolve Resolve a Construct install
• GET /api/agent/v1/construct/entitlements/manifest Read the signed grant manifest
• POST /api/agent/v1/construct/installs Report a Construct install
• POST /api/agent/v1/construct/reports Report a Construct package
• GET /api/account/agent-integrations/{attemptId}/credential Integrations: Inspect credential setup
• POST /api/account/agent-integrations/{attemptId}/credential Integrations: Save a provider API key
• GET /api/account/agent-pairing-handoffs/{handoffRef} Account: Inspect an agent pairing
• POST /api/account/agent-pairing-handoffs/{handoffRef}/confirm Account: Confirm an agent pairing
• GET /api/account/agent-security/registrations Account: List agent registrations
• PATCH /api/account/agent-security/registrations/{registrationRef} Account: Label an agent registration
• POST /api/account/agent-security/registrations/{registrationRef}/revoke Account: Revoke an agent registration
• GET /api/account/agent-security/runners Account: List agent runners
• GET /api/account/agent-security/runner-enrollments/{reviewRef} Account: Review a runner installation
• POST /api/account/agent-security/runner-enrollments/{reviewRef}/decision Account: Decide a runner installation request
• GET /api/account/agent-claim-moves/{moveRef} Account: Review moving a claimed agent into your account
• POST /api/account/agent-claim-moves/{moveRef}/decision Account: Confirm or cancel moving a claimed agent
• PATCH /api/account/agent-security/runners/{runnerRef} Account: Label an agent runner
• POST /api/account/agent-security/runners/{runnerRef}/rotate Account: Rotate an agent runner
• POST /api/account/agent-security/runners/{runnerRef}/revoke Account: Revoke an agent runner
• POST /api/account/agent-approval-settings/{agentRef}/handoffs/{handoffRef}/cancel Cancel a requested settings change
• POST /api/account/agent-approval-reviews/{approvalRef}/handoff Prepare a runner approval review
• GET /api/account/agent-approval-reviews/{approvalRef}/{handoffRef} Read a human approval review
• POST /api/account/agent-approval-reviews/{approvalRef}/{handoffRef}/decision Decide the reviewed approval
• GET /api/account/agent-approval-settings/{agentRef} Approvals: Get human agent approval settings
• PATCH /api/account/agent-approval-settings/{agentRef} Approvals: Update human agent approval settings
• GET /api/account/agent-approval-delegations?agentRef={agentRef} Approvals: List human agent approval delegations
• POST /api/account/agent-approval-delegations Approvals: Create human agent approval delegation
• GET /api/account/agent-approval-delegations/{delegationRef} Approvals: Get human agent approval delegation
• POST /api/account/agent-approval-delegations/{delegationRef}/revoke Approvals: Revoke human agent approval delegation
• POST /api/agent/checkout-handoffs/request Request a paid-plan handoff
• GET /api/agent/checkout-handoffs/{handoffRef} Inspect a paid-plan handoff
• POST /api/agent/checkout-handoffs/{handoffRef}/confirm Confirm a paid-plan handoff
• POST /api/agent/checkout-handoffs/completion Read the post-payment upgrade status

Agent developer index