Documentation navigation

OpenAPI

Quick start

Make your first CreatiVault OpenAPI request in a few minutes.

  1. Create an API key

    Create an API key in your CreatiVault account and keep it in a secure environment variable.

  2. Choose an endpoint

    Select an endpoint from a product group and check its required scope and request fields.

  3. Send a request

    Pass your key in the X-API-Key header and use the request example as a starting point.

Set your API key

Linux / macOS
export CV_API_KEY="your-api-key"
PowerShell
$env:CV_API_KEY = "your-api-key"

Make your first request

Request example
curl -X POST 'http://api.creativault.vip/openapi/v1/creators/tiktok/search' \
  -H 'Content-Type: application/json' \
  -H "X-API-Key: $CV_API_KEY" \
  --data '{
  "country_code": "US",
  "page": 1,
  "size": 5,
  "service_level": "S1",
  "lang": "en"
}'

Replace the placeholder key with a valid API key that has access to this endpoint.