Getting started

Quickstart

Make your first authenticated request.

Create a key

Open your project → Developer → Create key. Save the key securely; it is shown once. Set UGC_API_KEY in your local environment. Never embed a secret key in browser code or commit it.

Open DeveloperCreate and revoke personal API keys.

Find your project

The response includes your user ID and the projects authorized for this credential. Copy the project ID into UGC_PROJECT_ID.

bash

curl https://www.ugc.run/api/v1/me \
  -H "Authorization: Bearer $UGC_API_KEY"

Read creators

Successful responses contain data and request_id. Lists return data.data and data.next_cursor. Send the returned cursor with the same filters to read the next page.

bash

curl --get "https://www.ugc.run/api/v1/projects/$UGC_PROJECT_ID/creators" \
  -H "Authorization: Bearer $UGC_API_KEY" \
  --data-urlencode 'filters=[{"field":"archived","op":"eq","value":false}]' \
  --data-urlencode 'fields=["id","name"]' \
  --data-urlencode "limit=50"

Make a change

Keep the idempotency key and reuse it with identical input when retrying. Do not generate a new key for an uncertain or pending request. Fetch an operation's schema before calling it.

bash

curl -X PATCH "https://www.ugc.run/api/v1/projects/$UGC_PROJECT_ID/creators/$CREATOR_ID" \
  -H "Authorization: Bearer $UGC_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Alex Rivera"}'