Documentation

API keys and request logs

Create API keys for the Talynce REST API and audit requests made against them.

What it is

A self-service developer portal to create Bearer-token API keys for the Talynce REST API (/api/v1/*) and review the request log for each key.

Who can use it

Admins only. Requires a paid plan (Solo, for a single user, or Team) — organizations on the free plan won't see this feature available.

Where to find it

Administration → Developer; request history at Developer → Logs.

API keys and request logs screenshot

Steps

  1. Open Developer and create a new API key — copy it immediately, as the full value is typically only shown once.
  2. Use the key as a Bearer token against /api/v1/* endpoints.
  3. Revoke a key at any time if it's compromised or no longer needed.
  4. Review Logs to audit every request made with your keys, including response status.
  5. For endpoint-by-endpoint documentation (authentication, clients, jobs, candidates, applications, screenings, video interviews, errors), see the public REST API reference.

Good to know

  • Video interviews created through the API cost no credits — the same as interviews sent from the dashboard. They were charged 10 credits each until 19 November 2026; an older entry on your Credits page may still show that line. See What credits cost.
  • This feature is gated by plan, not by seat count: any paid plan has it, including a single-user one. If it's missing, check that your organization is on a paid plan rather than the free plan.

Common questions

  • Where's the full endpoint documentation? At /docs/api — this article only covers key management and logs, not individual endpoints.
  • Can a member create API keys? No — admin only.
  • What happens if I revoke a key that's in use? Requests using it immediately start failing authentication — coordinate with whoever built the integration before revoking.
  • Can I create more than one API key? Yes — many teams use separate keys per integration/environment so they can be revoked independently.
  • Does the request log show response bodies? It logs enough detail to debug status and timing; treat it as an audit/debugging trail rather than a full payload archive.

Related articles

Last updated: 11/19/20269 views