Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.veedcrawl.com/llms.txt

Use this file to discover all available pages before exploring further.

GET /v1/me returns your organization details and remaining credit balance. Call it to confirm your API key is valid, identify which org it belongs to, and check how many credits you have before running transcript or extraction jobs.

​
Endpoint

GET https://api.veedcrawl.com/v1/me

​
Authentication

This endpoint requires an x-api-key header.

​
Parameters

This endpoint takes no query parameters.

​
Example

curl "https://api.veedcrawl.com/v1/me" \
  -H "x-api-key: YOUR_KEY"

​
Response

{
  "orgId": "org_abc123",
  "name": "My Org",
  "creditsRemaining": 87
}
​
orgId
string
Your organization’s unique identifier.
​
name
string
Your organization’s display name.
​
creditsRemaining
number
Credits remaining in your current billing period.
Call GET /v1/me before running extract jobs to confirm you have enough credits. Each extraction costs 10 credits, and each Whisper transcription costs 5.