The base address

The base address

Every call sits under /api and your organisation’s code.

Example request

Under the base addressbash
curl "https://console.brevily.com/api/NORTHWIND/links" \  -H "x-api-key: brv_ak_7Fq2Lw9xK3" \  -H "x-api-secret: $BREVILY_SECRET"

Example answer

Another organisation’s codehttp
HTTP/1.1 404 Not Found{  "code": "NOT_FOUND",  "message": "Not found",  "requestId": "18188559082372202519"}

Made-up values.

https://console.brevily.com/api/{ORG}

Every call here sits under that address. {ORG} is your organisation’s code: the console shows it in Settings › General, as Code. The key answers only for its own organisation, so the code and the key go together. The exceptions sit right under https://console.brevily.com/api: get the person behind the key (/api/me). The MCP server answers at https://console.brevily.com/api/mcp.

What a call sends and getsPermalink

  • A body is JSON, sent with content-type: application/json, and at most 1 MB; a larger one answers 413 PAYLOAD_TOO_LARGE.
  • Every answer is JSON, and carries x-request-id: quote it to support.
  • A trailing slash makes no difference.
  • A method a path does not take answers 404 NOT_FOUND, as does a path that does not exist.

When it mattersPermalink

Build the address once, from configuration: the host is the console’s, not the website’s, and the code is the organisation’s. Copy the code from the console’s Settings › General, where it is listed as Code.

Common mistakesPermalink

  • Calling the website’s address, or the console’s without /api: those answer pages, not JSON.
  • Another organisation’s code with this key: it answers 404 NOT_FOUND, never another organisation’s records.
  • A form-encoded body: the calls read JSON only.