The API Key object

API keys provide programmatic access to the Transcodely API. Each key is scoped to a specific app and environment.

Important: The full API key secret is only returned once at creation. It cannot be retrieved again. Store it securely.

Base path: transcodely.v1.APIKeyService Requires: X-Organization-ID header on all endpoints.

Attributes

Attribute	Type	Description
`id`	string	Unique identifier. Prefixed with `ak_`.
`name`	string	Human-readable name.
`description`	string	Description of the key’s purpose. Omitted if not set.
`key_prefix`	string	Key prefix for identification (e.g., `"ak_live_"` or `"ak_test_"`). Safe to log.
`key_hint`	string	Last 4 characters of the key. Safe for customer support lookups.
`environment`	enum	One of: `live`, `test`.
`scopes`	string[]	Permission scopes. Empty means full access.
`last_used_at`	string	ISO 8601 timestamp of last use. Omitted if never used.
`expires_at`	string	ISO 8601 expiration timestamp. Omitted if no expiration.
`created_at`	string	ISO 8601 timestamp.
`is_revoked`	boolean	Whether the key has been revoked.
`revoked_at`	string	ISO 8601 timestamp. Omitted if not revoked.

{
  "id": "ak_x9y8z7w6v5",
  "name": "Production API Key",
  "description": "Used by the video processing pipeline",
  "key_prefix": "ak_live_",
  "key_hint": "n4o5",
  "environment": "live",
  "scopes": [],
  "last_used_at": "2025-02-28T14:22:00Z",
  "expires_at": "2026-01-15T10:30:00Z",
  "created_at": "2025-01-15T10:30:00Z",
  "is_revoked": false
}

Create an API key

Create a new API key. The full secret is returned only in this response — it cannot be retrieved again.

POST /transcodely.v1.APIKeyService/Create

Parameters

Parameter	Type	Required	Description
`name`	string	Yes	Human-readable name (1-255 chars). Example: `"Production API Key"`, `"CI/CD"`.
`description`	string	No	Description of the key’s purpose (max 1000 chars).
`environment`	string	Yes	Key environment: `"live"` or `"test"`.
`expires_at`	string	No	ISO 8601 expiration timestamp. Omit for keys that never expire.
`app_id`	string	No	App ID. Required when unauthenticated, ignored when authenticated (uses the authenticated app).

Returns

Returns an API Key object and a secret field containing the full key.

Store the secret securely. This is the only time the full API key is returned. Subsequent retrievals only include the key_prefix and key_hint.

curl -X POST https://api.transcodely.com/transcodely.v1.APIKeyService/Create 
  -H "Authorization: Bearer {{API_KEY}}" 
  -H "X-Organization-ID: {{ORG_ID}}" 
  -H "Content-Type: application/json" 
  -d '{
    "name": "Production API Key",
    "description": "Used by the video processing pipeline",
    "environment": "live",
    "app_id": "app_k1l2m3n4o5"
  }'

const created = await client.apiKeys.create({
  name: "Production API Key",
  description: "Used by the video processing pipeline",
  environment: APIKeyEnvironment.API_KEY_ENVIRONMENT_LIVE,
  appId: "app_k1l2m3n4o5",
});
// created.secret holds the full key — returned only here. Store it now.
console.log(created.apiKey?.id, created.secret);

created = client.api_keys.create(
    name="Production API Key",
    description="Used by the video processing pipeline",
    environment="live",
    app_id="app_k1l2m3n4o5",
)
# created.secret holds the full key — returned only here. Store it now.
print(created.api_key.id, created.secret)

created, err := client.APIKeys.Create(ctx, &transcodely.APIKeyCreateParams{
	Name:        "Production API Key",
	Description: "Used by the video processing pipeline",
	Environment: transcodely.APIKeyEnvironmentLive,
	AppId:       "app_k1l2m3n4o5",
})
// created.PlainText holds the full key — returned only here. Store it now.
fmt.Println(created.Key.GetId(), created.PlainText)

{
  "api_key": {
    "id": "ak_x9y8z7w6v5",
    "name": "Production API Key",
    "description": "Used by the video processing pipeline",
    "key_prefix": "ak_live_",
    "key_hint": "n4o5",
    "environment": "live",
    "scopes": [],
    "created_at": "2025-01-15T10:30:00Z",
    "is_revoked": false
  },
  "secret": "ak_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4"
}

Retrieve an API key

Retrieve an API key by its ID. The secret is never returned after creation.

POST /transcodely.v1.APIKeyService/Get

Parameters

Parameter	Type	Required	Description
`id`	string	Yes	API key ID (e.g., `"ak_x9y8z7w6v5"`).

Returns

Returns an API Key object (without the secret).

curl -X POST https://api.transcodely.com/transcodely.v1.APIKeyService/Get 
  -H "Authorization: Bearer {{API_KEY}}" 
  -H "X-Organization-ID: {{ORG_ID}}" 
  -H "Content-Type: application/json" 
  -d '{"id": "ak_x9y8z7w6v5"}'

const apiKey = await client.apiKeys.get("ak_x9y8z7w6v5");

api_key = client.api_keys.get("ak_x9y8z7w6v5")

apiKey, err := client.APIKeys.Get(ctx, "ak_x9y8z7w6v5")

{
  "api_key": {
    "id": "ak_x9y8z7w6v5",
    "name": "Production API Key",
    "description": "Used by the video processing pipeline",
    "key_prefix": "ak_live_",
    "key_hint": "n4o5",
    "environment": "live",
    "scopes": [],
    "last_used_at": "2025-02-28T14:22:00Z",
    "expires_at": "2026-01-15T10:30:00Z",
    "created_at": "2025-01-15T10:30:00Z",
    "is_revoked": false
  }
}

List API keys

List API keys with optional filtering by environment and revocation status.

POST /transcodely.v1.APIKeyService/List

Parameters

Parameter	Type	Required	Description
`environment`	string	No	Filter by environment: `"live"` or `"test"`.
`include_revoked`	boolean	No	If `true`, include revoked keys. Default: `false`.
`pagination`	object	No	Pagination parameters. See API Reference overview.

Returns

Returns a list of API Key objects and pagination metadata.

curl -X POST https://api.transcodely.com/transcodely.v1.APIKeyService/List 
  -H "Authorization: Bearer {{API_KEY}}" 
  -H "X-Organization-ID: {{ORG_ID}}" 
  -H "Content-Type: application/json" 
  -d '{
    "environment": "live",
    "include_revoked": false,
    "pagination": {"limit": 20}
  }'

for await (const apiKey of client.apiKeys.list({
  environment: APIKeyEnvironment.API_KEY_ENVIRONMENT_LIVE,
  includeRevoked: false,
  pagination: { limit: 20 },
}).autoPage()) {
  console.log(apiKey.id, apiKey.keyHint);
}

for api_key in client.api_keys.list(limit=20).auto_paging_iter():
    print(api_key.id, api_key.key_hint)

iter := client.APIKeys.List(ctx, &transcodely.APIKeyListParams{
	Environment:    transcodely.APIKeyEnvironmentLive.Enum(),
	IncludeRevoked: false,
	Pagination:     &transcodely.PaginationRequest{Limit: 20},
})
for iter.Next() {
	apiKey := iter.Current()
	fmt.Println(apiKey.GetId(), apiKey.GetKeyHint())
}
if err := iter.Err(); err != nil {
	log.Fatal(err)
}

{
  "api_keys": [
    {
      "id": "ak_x9y8z7w6v5",
      "name": "Production API Key",
      "description": "Used by the video processing pipeline",
      "key_prefix": "ak_live_",
      "key_hint": "n4o5",
      "environment": "live",
      "scopes": [],
      "last_used_at": "2025-02-28T14:22:00Z",
      "created_at": "2025-01-15T10:30:00Z",
      "is_revoked": false
    }
  ],
  "pagination": {
    "next_cursor": "",
    "total_count": 1
  }
}

Revoke an API key

Revoke an API key. Revoked keys immediately stop working for authentication and cannot be reactivated.

POST /transcodely.v1.APIKeyService/Revoke

Parameters

Parameter	Type	Required	Description
`id`	string	Yes	API key ID.
`reason`	string	No	Reason for revocation, stored for audit purposes (max 500 chars).

Returns

Returns the API Key object with is_revoked: true and revoked_at set.

curl -X POST https://api.transcodely.com/transcodely.v1.APIKeyService/Revoke 
  -H "Authorization: Bearer {{API_KEY}}" 
  -H "X-Organization-ID: {{ORG_ID}}" 
  -H "Content-Type: application/json" 
  -d '{
    "id": "ak_x9y8z7w6v5",
    "reason": "Key compromised, rotating credentials"
  }'

const apiKey = await client.apiKeys.revoke("ak_x9y8z7w6v5");

api_key = client.api_keys.revoke("ak_x9y8z7w6v5")

err := client.APIKeys.Revoke(ctx, "ak_x9y8z7w6v5")

{
  "api_key": {
    "id": "ak_x9y8z7w6v5",
    "name": "Production API Key",
    "description": "Used by the video processing pipeline",
    "key_prefix": "ak_live_",
    "key_hint": "n4o5",
    "environment": "live",
    "scopes": [],
    "created_at": "2025-01-15T10:30:00Z",
    "is_revoked": true,
    "revoked_at": "2025-02-28T15:00:00Z"
  }
}

#The API Key object

#Attributes

#Create an API key

#Parameters

#Returns

#Retrieve an API key

#Parameters

#Returns

#List API keys

#Parameters

#Returns

#Revoke an API key

#Parameters

#Returns

The API Key object

Attributes

Create an API key

Parameters

Returns

Retrieve an API key

Parameters

Returns

List API keys

Parameters

Returns

Revoke an API key

Parameters

Returns