nvoke Agents API
The Agents API from nvoke — 2 operation(s) for agents.
The Agents API from nvoke — 2 operation(s) for agents.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/nvoke-run:nvoke-run-agents-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: nvoke Agents API
version: 0.1.0
description: 'Find companies, read their websites and get email addresses checked with the mail server. Everything the desktop app does. Send `Authorization: Bearer `.'
servers:
- url: https://api.nvoke.run
tags:
- name: Agents
paths:
/v1/agents/signup:
post:
operationId: agentSignup
summary: Sign up as an agent
description: 'Creates an nvoke account for the person you work for and returns an API key at once. No browser, no human needed. The free plan applies: 50 verified emails a month. We send that person one email with a link to claim the account. Unclaimed accounts work for 7 days, then answer 403 `claim_required` until claimed, and are deleted after 30 days. Rate limited per IP, per email domain and per day.'
tags:
- Agents
security: []
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
maxLength: 320
format: email
pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
agentName:
type: string
minLength: 1
maxLength: 60
required:
- email
example:
email: ada@example.com
agentName: Claude
responses:
'201':
description: OK
content:
application/json:
schema:
type: object
properties:
apiKey:
type: string
format: starts_with
pattern: ^nvk_sk_.*
account:
type: object
properties:
email:
type: string
status:
type: string
const: unclaimed
claimEmailSent:
type: boolean
activeUntil:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
required:
- email
- status
- claimEmailSent
- activeUntil
additionalProperties: false
apiBase:
type: string
mcpUrl:
type: string
docsUrl:
type: string
nextSteps:
type: array
items:
type: string
required:
- apiKey
- account
- apiBase
- mcpUrl
- docsUrl
- nextSteps
additionalProperties: false
4XX:
description: '`invalid_request`: The body or query failed validation. `details` lists the problems.
`account_exists`: An account with this email exists. Ask the human for an API key.
`email_not_accepted`: Disposable inbox, an opted-out address, or a domain that receives no mail.
`rate_limited`: Too many requests of this kind from this account or client. Try again later.
`signup_unavailable`: Agent sign-up is switched off right now.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/v1/agents/claim:
get:
operationId: getClaim
summary: Read an account before claiming it
description: 'Called by the claim page on nvoke.run: who created the account and whether it is claimed. Unlike every other signed-in request, it does not claim the account.'
tags:
- Agents
security:
- bearer: []
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
account:
type: object
properties:
createdBy:
type: string
enum:
- human
- agent
agentName:
type:
- string
- 'null'
claimedAt:
anyOf:
- type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
- type: 'null'
required:
- createdBy
- agentName
- claimedAt
additionalProperties: false
required:
- account
additionalProperties: false
4XX:
description: '`unauthorized`: No valid token. Send `Authorization: Bearer <key>`.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
operationId: claimAccount
summary: Claim an account an agent created
description: Called by the claim page on nvoke.run after the human signs in from the emailed link. Accepts the terms and keeps or revokes the agent’s key.
tags:
- Agents
security:
- bearer: []
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
acceptTerms:
type: boolean
const: true
keepAgentKeys:
type: boolean
required:
- acceptTerms
- keepAgentKeys
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
account:
type: object
properties:
createdBy:
type: string
enum:
- human
- agent
agentName:
type:
- string
- 'null'
claimedAt:
anyOf:
- type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
- type: 'null'
required:
- createdBy
- agentName
- claimedAt
additionalProperties: false
revokedKeys:
type: integer
minimum: 0
maximum: 9007199254740991
required:
- account
- revokedKeys
additionalProperties: false
4XX:
description: '`unauthorized`: No valid token. Send `Authorization: Bearer <key>`.
`invalid_request`: The body or query failed validation. `details` lists the problems.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
required:
- error
properties:
error:
type: string
enum:
- unauthorized
- claim_required
- invalid_request
- not_found
- quota_exceeded
- source_unavailable
- not_cancelable
- search_running
- kind_mismatch
- ongoing_not_supported
- search_canceled
- not_claimed
- api_key_limit
- account_exists
- email_not_accepted
- rate_limited
- captcha_failed
- busy
- site_unreadable
- ai_unavailable
- ai_key_rejected
- ai_model_unknown
- search_key_rejected
- signup_unavailable
- too_many_drops
- too_many_webhooks
- webhook_url_not_allowed
- database_unavailable
details: {}
securitySchemes:
bearer:
type: http
scheme: bearer
description: An API key (nvk_sk_...) or an OAuth access token from nvoke’s Clerk.