πŸ”‘

Projects & API Tokens

Project-scoped configuration and authentication

A Project is a workspace that encapsulates configuration and data for a single application or client. You can create multiple projects. Each project has its own categories, schemas, moderation settings, and tokens.

πŸ“Projects

Use projects to separate products, client workspaces, or sandboxes. Configuration and access are isolated per project.

Typical Use Cases

  • β€’ One project per application or microservice
  • β€’ One project per customer (multi-tenant isolation)
  • β€’ Temporary projects for testing or demos
  • β€’ Optional: separate projects for dev/stage/prod if you want strict isolation

What a Project Contains

Project identity & settings

Each project has a Name and a Project ID (slug). The Project ID appears in Console URLs (e.g., /console/<project_id>) and can be changed from Console β†’ Settings. Renaming affects only the display name; updating the Project ID changes the URL segment for the project in Console.

Isolation model

Categories, schemas, automated/manual settings, submissions, and tokens are scoped to one project and are not shared across projects. Deleting a project removes its configuration and invalidates all of its tokens.

πŸ”’API Tokens

Tokens authenticate your API requests. A token is scoped to exactly one project and inherits that project's settings.

Capabilities

  • β€’ Named tokens β€” Label tokens by service or environment
  • β€’ Instant revocation β€” Disable compromised tokens immediately

What you can do in Console β†’ Tokens

  • β€’ List tokens β€” See existing tokens with their names
  • β€’ Create token β€” Provide a descriptive name; token becomes immediately usable
  • β€’ Reveal/hide token value β€” Temporarily reveal a token to copy it
  • β€’ Copy to clipboard β€” One-click copy for integration
  • β€’ Delete token β€” Immediately revokes access for that token

Generate a Token

  1. 1. Open Console β†’ Tokens in the target project
  2. 2. Click Generate Token
  3. 3. Provide a descriptive name (e.g., "checkout-service-prod")
  4. 4. Copy and store it securely (environment variables)

Token rotation

  1. 1. Create a new token and deploy it to your services
  2. 2. Verify it’s used in production
  3. 3. Revoke the old token

Use the Token

Include your API token in the Authorization header for all API requests:

GET https://api.outharm.com/health
Authorization: Bearer YOUR_TOKEN_HERE

Best Practices

Security

  • β€’ Store tokens in server-side environment variables
  • β€’ Rotate and revoke tokens regularly
  • β€’ Do not embed tokens in client-side code

Organization

  • β€’ Use meaningful names: service-environment
  • β€’ Prefer separate tokens per service

Ready to Get Started?

Create your first project and generate API tokens to start building with Outharm's content moderation platform.

Related Documentation