Projects

Methods

TypeScript
Python
Rust

List attachments

TypeScript

photon.projects.listAttachments(input: ListAttachmentsInput, options?: RequestOptions): Promise<ListAttachmentsOutput>

GET /v1/projects/{id}/attachmentsList project API keys

TypeScript

photon.projects.listProjectApiKeys(input: ListProjectApiKeysInput, options?: RequestOptions): Promise<ListProjectApiKeysOutput>

GET /v1/projects/{projectId}/api-keysList webhook API versions

TypeScript

photon.projects.listWebhookApiVersions(input: ListWebhookApiVersionsInput, options?: RequestOptions): Promise<ListWebhookApiVersionsOutput>

GET /v1/projects/{projectId}/webhooks/api-versionsList webhook destinations

TypeScript

photon.projects.listWebhookDestinations(input: ListWebhookDestinationsInput, options?: RequestOptions): Promise<ListWebhookDestinationsOutput>

GET /v1/projects/{projectId}/webhooks/destinationsList webhook egress addresses

TypeScript

photon.projects.listWebhookEgressAddresses(input: ListWebhookEgressAddressesInput, options?: RequestOptions): Promise<ListWebhookEgressAddressesOutput>

GET /v1/projects/{projectId}/webhooks/egress-addressesList webhook event types

TypeScript

photon.projects.listWebhookEventTypes(input: ListWebhookEventTypesInput, options?: RequestOptions): Promise<ListWebhookEventTypesOutput>

GET /v1/projects/{projectId}/webhooks/event-typesDownload attachment

TypeScript

photon.projects.downloadAttachment(input: DownloadAttachmentInput, options?: RequestOptions): Promise<DownloadAttachmentOutput>

GET /v1/projects/{id}/attachments/{attachmentId}/contentGet project

TypeScript

photon.projects.get(input: GetProjectInput, options?: RequestOptions): Promise<GetProjectOutput>

GET /v1/projects/{projectId}Get attachment

TypeScript

photon.projects.getAttachment(input: GetAttachmentInput, options?: RequestOptions): Promise<GetAttachmentOutput>

GET /v1/projects/{id}/attachments/{attachmentId}Get metrics backfill status

TypeScript

photon.projects.getMessageMetricsBackfill(input: GetMessageMetricsBackfillInput, options?: RequestOptions): Promise<GetMessageMetricsBackfillOutput>

GET /v1/projects/{projectId}/metrics/backfillGet metrics SQL schema

TypeScript

photon.projects.getMessageMetricsSqlSchema(input: GetMessageMetricsSqlSchemaInput, options?: RequestOptions): Promise<GetMessageMetricsSqlSchemaOutput>

GET /v1/projects/{projectId}/metrics/queryGet webhook destination

TypeScript

photon.projects.getWebhookDestination(input: GetWebhookDestinationInput, options?: RequestOptions): Promise<GetWebhookDestinationOutput>

GET /v1/projects/{projectId}/webhooks/destinations/{destinationId}Get webhook event schema

TypeScript

photon.projects.getWebhookEventSchema(input: GetWebhookEventSchemaInput, options?: RequestOptions): Promise<GetWebhookEventSchemaOutput>

GET /v1/projects/{projectId}/webhooks/event-types/{eventType}/schemaCreate project API key

TypeScript

photon.projects.createProjectApiKey(input: CreateProjectApiKeyInput, options?: RequestOptions): Promise<CreateProjectApiKeyOutput>

POST /v1/projects/{projectId}/api-keysCreate webhook destination

TypeScript

photon.projects.createWebhookDestination(input: CreateWebhookDestinationInput, options?: RequestOptions): Promise<CreateWebhookDestinationOutput>

POST /v1/projects/{projectId}/webhooks/destinationsQuery metrics

TypeScript

photon.projects.queryMessageMetrics(input: QueryMessageMetricsInput, options?: RequestOptions): Promise<QueryMessageMetricsOutput>

POST /v1/projects/{projectId}/metrics/queryRetry webhook delivery

TypeScript

photon.projects.retryWebhookDelivery(input: RetryWebhookDeliveryInput, options?: RequestOptions): Promise<RetryWebhookDeliveryOutput>

POST /v1/projects/{projectId}/webhooks/destinations/{destinationId}/retriesRotate webhook signing secret

TypeScript

photon.projects.rotateWebhookSigningSecret(input: RotateWebhookSigningSecretInput, options?: RequestOptions): Promise<RotateWebhookSigningSecretOutput>

POST /v1/projects/{projectId}/webhooks/destinations/{destinationId}/secret-rotationsUpload attachment

TypeScript

photon.projects.uploadAttachment(input: UploadAttachmentInput, options?: RequestOptions): Promise<UploadAttachmentOutput>

POST /v1/projects/{id}/attachmentsUpdate project

TypeScript

photon.projects.update(input: UpdateProjectInput, options?: RequestOptions): Promise<UpdateProjectOutput>

PATCH /v1/projects/{projectId}Update project API key permissions

TypeScript

photon.projects.updateProjectApiKey(input: UpdateProjectApiKeyInput, options?: RequestOptions): Promise<UpdateProjectApiKeyOutput>

PATCH /v1/projects/{projectId}/api-keys/{apiKeyId}Update webhook destination

TypeScript

photon.projects.updateWebhookDestination(input: UpdateWebhookDestinationInput, options?: RequestOptions): Promise<UpdateWebhookDestinationOutput>

PATCH /v1/projects/{projectId}/webhooks/destinations/{destinationId}Delete project

TypeScript

photon.projects.delete(input: DeleteProjectInput, options?: RequestOptions): Promise<DeleteProjectOutput>

DELETE /v1/projects/{projectId}Delete webhook destination

TypeScript

photon.projects.deleteWebhookDestination(input: DeleteWebhookDestinationInput, options?: RequestOptions): Promise<DeleteWebhookDestinationOutput>

DELETE /v1/projects/{projectId}/webhooks/destinations/{destinationId}Revoke project API key

TypeScript

photon.projects.revokeProjectApiKey(input: RevokeProjectApiKeyInput, options?: RequestOptions): Promise<RevokeProjectApiKeyOutput>

DELETE /v1/projects/{projectId}/api-keys/{apiKeyId}

List attachments

Python

photon.projects.list_attachments(input: ListAttachmentsInput) -> models.AttachmentPage

GET /v1/projects/{id}/attachmentsList project API keys

Python

photon.projects.list_project_api_keys(input: ListProjectApiKeysInput) -> models.ListProjectApiKeysResponse

GET /v1/projects/{projectId}/api-keysList webhook API versions

Python

photon.projects.list_webhook_api_versions(input: ListWebhookApiVersionsInput) -> models.ListWebhookApiVersionsResponse | None

GET /v1/projects/{projectId}/webhooks/api-versionsList webhook destinations

Python

photon.projects.list_webhook_destinations(input: ListWebhookDestinationsInput) -> models.WebhookDestinationPage

GET /v1/projects/{projectId}/webhooks/destinationsList webhook egress addresses

Python

photon.projects.list_webhook_egress_addresses(input: ListWebhookEgressAddressesInput) -> models.ListWebhookEgressAddressesResponse | None

GET /v1/projects/{projectId}/webhooks/egress-addressesList webhook event types

Python

photon.projects.list_webhook_event_types(input: ListWebhookEventTypesInput) -> models.ListWebhookEventTypesResponse | None

GET /v1/projects/{projectId}/webhooks/event-typesDownload attachment

Python

photon.projects.download_attachment(input: DownloadAttachmentInput) -> bytes

GET /v1/projects/{id}/attachments/{attachmentId}/contentGet project

Python

photon.projects.get(input: GetProjectInput) -> models.Project

GET /v1/projects/{projectId}Get attachment

Python

photon.projects.get_attachment(input: GetAttachmentInput) -> models.Attachment

GET /v1/projects/{id}/attachments/{attachmentId}Get metrics backfill status

Python

photon.projects.get_message_metrics_backfill(input: GetMessageMetricsBackfillInput) -> models.GetMessageMetricsBackfillResponse

GET /v1/projects/{projectId}/metrics/backfillGet metrics SQL schema

Python

photon.projects.get_message_metrics_sql_schema(input: GetMessageMetricsSqlSchemaInput) -> models.GetMessageMetricsSqlSchemaResponse

GET /v1/projects/{projectId}/metrics/queryGet webhook destination

Python

photon.projects.get_webhook_destination(input: GetWebhookDestinationInput) -> models.WebhookDestination

GET /v1/projects/{projectId}/webhooks/destinations/{destinationId}Get webhook event schema

Python

photon.projects.get_webhook_event_schema(input: GetWebhookEventSchemaInput) -> models.WebhookEventSchema | None

GET /v1/projects/{projectId}/webhooks/event-types/{eventType}/schemaCreate project API key

Python

photon.projects.create_project_api_key(input: CreateProjectApiKeyInput) -> models.CreateProjectApiKeyResponse

POST /v1/projects/{projectId}/api-keysCreate webhook destination

Python

photon.projects.create_webhook_destination(input: CreateWebhookDestinationInput) -> models.CreateWebhookDestinationResponse

POST /v1/projects/{projectId}/webhooks/destinationsQuery metrics

Python

photon.projects.query_message_metrics(input: QueryMessageMetricsInput) -> models.QueryMessageMetricsResponse

POST /v1/projects/{projectId}/metrics/queryRetry webhook delivery

Python

photon.projects.retry_webhook_delivery(input: RetryWebhookDeliveryInput) -> models.RetryWebhookDeliveryResponse

POST /v1/projects/{projectId}/webhooks/destinations/{destinationId}/retriesRotate webhook signing secret

Python

photon.projects.rotate_webhook_signing_secret(input: RotateWebhookSigningSecretInput) -> models.RotateWebhookSigningSecretResponse

POST /v1/projects/{projectId}/webhooks/destinations/{destinationId}/secret-rotationsUpload attachment

Python

photon.projects.upload_attachment(input: UploadAttachmentInput) -> models.Attachment

POST /v1/projects/{id}/attachmentsUpdate project

Python

photon.projects.update(input: UpdateProjectInput) -> models.Project

PATCH /v1/projects/{projectId}Update project API key permissions

Python

photon.projects.update_project_api_key(input: UpdateProjectApiKeyInput) -> models.ProjectApiKeyResponse

PATCH /v1/projects/{projectId}/api-keys/{apiKeyId}Update webhook destination

Python

photon.projects.update_webhook_destination(input: UpdateWebhookDestinationInput) -> models.WebhookDestination

PATCH /v1/projects/{projectId}/webhooks/destinations/{destinationId}Delete project

Python

photon.projects.delete(input: DeleteProjectInput) -> models.Project

DELETE /v1/projects/{projectId}Delete webhook destination

Python

photon.projects.delete_webhook_destination(input: DeleteWebhookDestinationInput) -> models.WebhookDestination

DELETE /v1/projects/{projectId}/webhooks/destinations/{destinationId}Revoke project API key

Python

photon.projects.revoke_project_api_key(input: RevokeProjectApiKeyInput) -> models.ProjectApiKeyResponse

DELETE /v1/projects/{projectId}/api-keys/{apiKeyId}

List attachments

Rust

client.list_attachments(id: String, params: Option<ListAttachmentsParams>).await -> Result<ResponseValue<types::AttachmentPage>, Error<ListAttachmentsError>>

GET /v1/projects/{id}/attachmentsList project API keys

Rust

client.list_project_api_keys(project_id: String).await -> Result<ResponseValue<types::ListProjectApiKeysResponse>, Error<ListProjectApiKeysError>>

GET /v1/projects/{projectId}/api-keysList webhook API versions

Rust

client.list_webhook_api_versions(project_id: String).await -> Result<ResponseValue<ListWebhookApiVersionsResponse>, Error<ListWebhookApiVersionsError>>

GET /v1/projects/{projectId}/webhooks/api-versionsList webhook destinations

Rust

client.list_webhook_destinations(project_id: String, params: Option<ListWebhookDestinationsParams>).await -> Result<ResponseValue<types::WebhookDestinationPage>, Error<ListWebhookDestinationsError>>

GET /v1/projects/{projectId}/webhooks/destinationsList webhook egress addresses

Rust

client.list_webhook_egress_addresses(project_id: String).await -> Result<ResponseValue<ListWebhookEgressAddressesResponse>, Error<ListWebhookEgressAddressesError>>

GET /v1/projects/{projectId}/webhooks/egress-addressesList webhook event types

Rust

client.list_webhook_event_types(project_id: String, api_version: Date).await -> Result<ResponseValue<ListWebhookEventTypesResponse>, Error<ListWebhookEventTypesError>>

GET /v1/projects/{projectId}/webhooks/event-typesDownload attachment

Rust

client.download_attachment(attachment_id: String, id: String).await -> Result<ResponseValue<bytes::Bytes>, Error<DownloadAttachmentError>>

GET /v1/projects/{id}/attachments/{attachmentId}/contentGet project

Rust

client.get_project(project_id: String).await -> Result<ResponseValue<types::Project>, Error<GetProjectError>>

GET /v1/projects/{projectId}Get attachment

Rust

client.get_attachment(attachment_id: String, id: String).await -> Result<ResponseValue<types::Attachment>, Error<GetAttachmentError>>

GET /v1/projects/{id}/attachments/{attachmentId}Get metrics backfill status

Rust

client.get_message_metrics_backfill(project_id: String, params: Option<GetMessageMetricsBackfillParams>).await -> Result<ResponseValue<types::GetMessageMetricsBackfillResponse>, Error<GetMessageMetricsBackfillError>>

GET /v1/projects/{projectId}/metrics/backfillGet metrics SQL schema

Rust

client.get_message_metrics_sql_schema(project_id: String, params: Option<GetMessageMetricsSqlSchemaParams>).await -> Result<ResponseValue<types::GetMessageMetricsSqlSchemaResponse>, Error<GetMessageMetricsSqlSchemaError>>

GET /v1/projects/{projectId}/metrics/queryGet webhook destination

Rust

client.get_webhook_destination(destination_id: String, project_id: String).await -> Result<ResponseValue<types::WebhookDestination>, Error<GetWebhookDestinationError>>

GET /v1/projects/{projectId}/webhooks/destinations/{destinationId}Get webhook event schema

Rust

client.get_webhook_event_schema(project_id: String, event_type: String, api_version: Date).await -> Result<ResponseValue<GetWebhookEventSchemaResponse>, Error<GetWebhookEventSchemaError>>

GET /v1/projects/{projectId}/webhooks/event-types/{eventType}/schemaCreate project API key

Rust

client.create_project_api_key(idempotency_key: String, project_id: String, body: &types::CreateProjectApiKeyRequest).await -> Result<ResponseValue<types::CreateProjectApiKeyResponse>, Error<CreateProjectApiKeyError>>

POST /v1/projects/{projectId}/api-keysCreate webhook destination

Rust

client.create_webhook_destination(idempotency_key: String, project_id: String, body: &types::CreateWebhookDestinationRequest).await -> Result<ResponseValue<types::CreateWebhookDestinationResponse>, Error<CreateWebhookDestinationError>>

POST /v1/projects/{projectId}/webhooks/destinationsQuery metrics

Rust

client.query_message_metrics(project_id: String, params: Option<QueryMessageMetricsParams>, body: &types::ClickHouseSqlQueryRequest).await -> Result<ResponseValue<types::QueryMessageMetricsResponse>, Error<QueryMessageMetricsError>>

POST /v1/projects/{projectId}/metrics/queryRetry webhook delivery

Rust

client.retry_webhook_delivery(idempotency_key: String, destination_id: String, project_id: String, body: &types::RetryWebhookDeliveryRequest).await -> Result<ResponseValue<types::RetryWebhookDeliveryResponse>, Error<RetryWebhookDeliveryError>>

POST /v1/projects/{projectId}/webhooks/destinations/{destinationId}/retriesRotate webhook signing secret

Rust

client.rotate_webhook_signing_secret(idempotency_key: String, destination_id: String, project_id: String, body: &types::RotateWebhookSigningSecretRequest).await -> Result<ResponseValue<types::RotateWebhookSigningSecretResponse>, Error<RotateWebhookSigningSecretError>>

POST /v1/projects/{projectId}/webhooks/destinations/{destinationId}/secret-rotationsUpload attachment

Rust

client.upload_attachment(id: String, content_length: String, content_type: String, idempotency_key: String, body: &bytes::Bytes).await -> Result<ResponseValue<UploadAttachmentResponse>, Error<UploadAttachmentError>>

POST /v1/projects/{id}/attachmentsUpdate project

Rust

client.update_project(idempotency_key: String, project_id: String, body: &types::UpdateProjectRequest).await -> Result<ResponseValue<types::Project>, Error<UpdateProjectError>>

PATCH /v1/projects/{projectId}Update project API key permissions

Rust

client.update_project_api_key(idempotency_key: String, api_key_id: String, project_id: String, body: &types::UpdateProjectApiKeyRequest).await -> Result<ResponseValue<types::ProjectApiKeyResponse>, Error<UpdateProjectApiKeyError>>

PATCH /v1/projects/{projectId}/api-keys/{apiKeyId}Update webhook destination

Rust

client.update_webhook_destination(idempotency_key: String, destination_id: String, project_id: String, body: &types::UpdateWebhookDestinationRequest).await -> Result<ResponseValue<types::WebhookDestination>, Error<UpdateWebhookDestinationError>>

PATCH /v1/projects/{projectId}/webhooks/destinations/{destinationId}Delete project

Rust

client.delete_project(idempotency_key: String, project_id: String).await -> Result<ResponseValue<types::Project>, Error<DeleteProjectError>>

DELETE /v1/projects/{projectId}Delete webhook destination

Rust

client.delete_webhook_destination(destination_id: String, project_id: String).await -> Result<ResponseValue<types::WebhookDestination>, Error<DeleteWebhookDestinationError>>

DELETE /v1/projects/{projectId}/webhooks/destinations/{destinationId}Revoke project API key

Rust

client.revoke_project_api_key(idempotency_key: String, api_key_id: String, project_id: String).await -> Result<ResponseValue<types::ProjectApiKeyResponse>, Error<RevokeProjectApiKeyError>>

DELETE /v1/projects/{projectId}/api-keys/{apiKeyId}

Resources

Models

AttachmentPage

array of Attachment

required

string

Continue with this token, even if items is empty. Omitted when no more pages remain.

ListProjectApiKeysResponse

array of ApiKey

required

ListWebhookApiVersionsResponse

array of WebhookApiVersion

required

"@photon-hq/contracts"

required

string

required

WebhookDestinationPage

array of WebhookDestination

required

string

ListWebhookEgressAddressesResponse

array of string (ipv4)

required

Every public IPv4 address webhook deliveries can originate from. Allow-list all of them; deliveries are spread across every address.

ListWebhookEventTypesResponse

One of: SelectableWebhookEventCatalog

string (date)

required

"@photon-hq/contracts"

required

array of WebhookEventType

required

string

required

WebhookApiVersionRetirement | null

required

true

required

SelectableWebhookApiVersionStatus

required

string (date) | null

required

One of: DeprecatedWebhookEventCatalog

string (date)

required

"@photon-hq/contracts"

required

array of WebhookEventType

required

string

required

WebhookApiVersionRetirement

required

false

required

"deprecated"

required

string (date) | null

required

Project

AgentProfile

required

ProjectBillingInitialization

string (date-time)

required

string | null

required

string | null

required

ProjectCreatedByActorKind | null

required

string (date-time) | null

required

string

required

string

required

string

required

string

required

string (date-time)

required

Attachment

string

required

string (date-time)

required

string

required

object

string

required

integer

required

string (date-time)

required

GetMessageMetricsBackfillResponse

integer

required

string (date-time) | null

required

integer

required

MessageMetricsBackfillState

required

string (date)

required

GetMessageMetricsSqlSchemaResponse

MessageMetricsSqlCapabilities

required

string

required

MessageMetricsSqlLimits

required

true

required

array of MessageMetricsSqlTable

required

string (date)

required

WebhookDestination

string (date)

required

string (date-time)

required

string (date-time) | null

required

string | null

required

string

required

WebhookEventSelection

required

string

required

string

required

WebhookDestinationStatus

required

string (date-time)

required

string (uri)

required

CreateProjectApiKeyResponse

ApiKey

required

string

required

CreateWebhookDestinationResponse

WebhookDestination

required

string

required

QueryMessageMetricsResponse

array of MessageMetricsQueryColumn

required

array of array of object

required

MessageMetricsQueryStatistics

required

RetryWebhookDeliveryResponse

"accepted"

required

RotateWebhookSigningSecretResponse

string (date-time) | null

required

string

required

ProjectApiKeyResponse

ApiKey

required

Get started

Guides

Reference

SDK reference

Methods

Resources

Models

AttachmentPage

ListProjectApiKeysResponse

ListWebhookApiVersionsResponse

WebhookDestinationPage

ListWebhookEgressAddressesResponse

ListWebhookEventTypesResponse

Project

Attachment

GetMessageMetricsBackfillResponse

GetMessageMetricsSqlSchemaResponse

WebhookDestination

CreateProjectApiKeyResponse

CreateWebhookDestinationResponse

QueryMessageMetricsResponse

RetryWebhookDeliveryResponse

RotateWebhookSigningSecretResponse

ProjectApiKeyResponse

​Methods

​Resources

​Models

​AttachmentPage

​ListProjectApiKeysResponse

​ListWebhookApiVersionsResponse

​WebhookDestinationPage

​ListWebhookEgressAddressesResponse

​ListWebhookEventTypesResponse

​Project

​Attachment

​GetMessageMetricsBackfillResponse

​GetMessageMetricsSqlSchemaResponse

​WebhookDestination

​CreateProjectApiKeyResponse

​CreateWebhookDestinationResponse

​QueryMessageMetricsResponse

​RetryWebhookDeliveryResponse

​RotateWebhookSigningSecretResponse

​ProjectApiKeyResponse

Methods

Resources

Models

AttachmentPage

ListProjectApiKeysResponse

ListWebhookApiVersionsResponse

WebhookDestinationPage

ListWebhookEgressAddressesResponse

ListWebhookEventTypesResponse

Project

Attachment

GetMessageMetricsBackfillResponse

GetMessageMetricsSqlSchemaResponse

WebhookDestination

CreateProjectApiKeyResponse

CreateWebhookDestinationResponse

QueryMessageMetricsResponse

RetryWebhookDeliveryResponse

RotateWebhookSigningSecretResponse

ProjectApiKeyResponse