Skip to content

Register (agent keys)

An agent that finds Portfolio Intel with no credentials can issue itself a free test key in one unauthenticated call. No browser, no human.

The MCP server card says what the server is and how to reach it (SEP-1649):

Terminal window
curl -s https://api.portfoliointel.co.in/.well-known/mcp/server-card.json
{
"name": "portfolio-intel",
"transport": { "type": "streamable-http", "endpoint": "https://api.portfoliointel.co.in/mcp" },
"capabilities": { "tools": true, "resources": false, "prompts": false },
"authentication": {
"type": "oauth2",
"discovery": "https://api.portfoliointel.co.in/.well-known/oauth-authorization-server"
},
"documentation": "https://docs.portfoliointel.co.in/"
}

POST https://api.portfoliointel.co.in/api/v1/register

All body fields are optional.

FieldTypeNotes
labelstringUp to 120 characters. Default Agent self-serve key.
scopestring[]Any of parse, enrich. Default both; unknown values are dropped.
claim_emailstringWhere the claim should go, if you already know the owner.
Terminal window
curl -s -X POST https://api.portfoliointel.co.in/api/v1/register \
-H "Content-Type: application/json" \
-d '{"label":"my-agent"}'
{
"success": true,
"api_key": "sk_test_…",
"key_id": "…",
"type": "test",
"credits_remaining": 30,
"expires_at": "2026-10-02T09:00:00.000Z",
"claim_code": "…",
"claim_url": "https://portfoliointel.co.in/portal?claim=…"
}

The key is a sk_test_ key with 30 credits (about 3 parses), a 60 requests/minute rate limit, and a 7-day expiry. api_key is shown once — store it. Claiming the key (below) raises it to 100 credits in total and 30 days from the claim; credits already spent stay spent.

claim_url lets a person attach the key to their account in the developer portal. Give it to your user if the key should outlive the session: an unclaimed key expires after 7 days.

WhereLimitResponse
Edge (per IP)3 registrations per hour429
Origin (per network)5 registrations per 24 hours429 RATE_LIMITED, Retry-After: 86400
Origin (all callers)Fixed number of new keys per UTC day429 DAILY_CAP_REACHED, Retry-After until 00:00 UTC

A network is an IPv4 address, or an IPv6 /64.

StatusCodeWhen
400INVALID_LABELlabel longer than 120 characters
400INVALID_EMAILclaim_email is not an email address
429RATE_LIMITEDSee above
429DAILY_CAP_REACHEDThe day’s free keys are used up