> ## Documentation Index > Fetch the complete documentation index at: https://docs.photon.codes/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code. > Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer. > For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them. > The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes. # Count Messages > Counts matching Messages before pagination. Delivery updates do not add Messages; results are eventually consistent. ## OpenAPI ````yaml https://api.photon.codes/openapi.json get /v1/projects/{id}/messages/count openapi: 3.1.0 info: title: Photon API version: 1.0.0 servers: - url: https://api.photon.codes security: [] paths: /v1/projects/{id}/messages/count: get: tags: - Messages summary: Count Messages description: >- Counts matching Messages before pagination. Delivery updates do not add Messages; results are eventually consistent. operationId: countMessages parameters: - in: path name: id required: true schema: pattern: ^pho_prj_[0-7][0-9a-hjkmnp-tv-z]{25}$ type: string - description: >- Exclusive upper bound on createdAt, RFC 3339. Cannot combine with updatedAt bounds. in: query name: createdBefore schema: format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ type: string - description: >- Inclusive lower bound on createdAt, RFC 3339. Cannot combine with updatedAt bounds. in: query name: createdSince schema: format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ type: string - description: >- Message origin: received or dispatched, including later delivery outcomes in: query name: direction schema: $ref: '#/components/schemas/MessageDirection' - description: >- Comma-separated content types to exclude from resource-scoped Message lists and counts. Requires resourceId. A group is excluded when group is selected or all of its parts are excluded; retained Messages are unchanged. Supported values: attachment, group, message.delete, message.read, poll, poll.update, poll.vote, reaction, space.participants.update, space.typing.update, text, text.update, voice. in: query name: excludeContentTypes schema: maxLength: 1024 type: string - description: >- Selects this User's sent or received Messages. Requires spaceId; cannot combine with resourceId. in: query name: perspectiveUserId schema: pattern: ^pho_usr_[0-7][0-9a-hjkmnp-tv-z]{25}$ type: string - description: Restricts the page to one platform in: query name: platform schema: $ref: '#/components/schemas/Platform' - description: >- Resource associated with the Message when sent or received. Can combine with spaceId, but not perspectiveUserId. in: query name: resourceId schema: pattern: ^pho_res_[0-7][0-9a-hjkmnp-tv-z]{25}$ type: string - description: >- Requires resourceId or perspectiveUserId. User perspectives use created_at order and exclude time bounds and platform filters. in: query name: spaceId schema: pattern: ^pho_spc_[0-7][0-9a-hjkmnp-tv-z]{25}$ type: string - description: >- Exclusive upper bound on updatedAt, RFC 3339. Cannot combine with createdAt bounds. in: query name: updatedBefore schema: format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ type: string - description: >- Inclusive lower bound on updatedAt, RFC 3339. Cannot combine with createdAt bounds. in: query name: updatedSince schema: format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ type: string - description: Split counts into received and sent groups. in: query name: groupBy schema: const: direction type: string - description: Calendar-day counts by Message.createdAt in: query name: interval schema: const: day type: string - description: >- IANA zone for calendar-day buckets; defaults to UTC; requires interval in: query name: timeZone schema: maxLength: 100 minLength: 1 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CountMessagesResponse' description: Matching Message count, optional direction groups and daily buckets headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '401': content: application/problem+json: schema: $ref: '#/components/schemas/NotAuthenticatedProblem' description: 'NOT_AUTHENTICATED: Not Authenticated' headers: Link: description: Optional related resources. schema: type: string RateLimit: description: Optional rate limit information. schema: type: string RateLimit-Policy: description: Optional rate limit policy. schema: type: string Retry-After: description: Optional retry delay or HTTP date. schema: type: string WWW-Authenticate: required: true schema: type: string X-Request-ID: description: Application request identifier. schema: type: string '403': content: application/problem+json: schema: $ref: '#/components/schemas/CountMessagesForbiddenProblem' description: >- FORBIDDEN: Forbidden; RESOURCE_MISMATCH: Resource Mismatch FORBIDDEN: Forbidden; INSUFFICIENT_SCOPE: Insufficient Scope; ORGANIZATION_SSO_REQUIRED: Organization SSO Required headers: Deprecation: description: >- RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`. schema: pattern: ^@-?[0-9]+$ type: string Idempotent-Replayed: description: True when this response was replayed from an earlier attempt. schema: type: boolean Link: description: |- Links related to lifecycle or remediation documentation. Optional related resources. schema: type: string RateLimit: description: |- Current rate-limit state. Optional rate limit information. schema: type: string RateLimit-Policy: description: |- Rate-limit policy applied by the gateway. Optional rate limit policy. schema: type: string Retry-After: description: |- Delay before retrying, in seconds or as an HTTP date. Optional retry delay or HTTP date. schema: type: string Sunset: description: >- RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`. schema: pattern: >- ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$ type: string X-Request-ID: description: |- Identifier for this HTTP attempt. Application request identifier. schema: type: string X-Trace-ID: description: >- Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request. schema: pattern: ^(?!0{32}$)[0-9a-f]{32}$ type: string '422': content: application/problem+json: schema: $ref: '#/components/schemas/ValidationFailedProblem' description: 'VALIDATION_FAILED: Request Validation Failed' headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '500': content: application/problem+json: schema: $ref: '#/components/schemas/CountMessagesInternalServerErrorProblem' description: |- INVALID_AUTH_CONTEXT: Invalid Authentication Context INTERNAL_ERROR: Internal Server Error headers: Deprecation: description: >- RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`. schema: pattern: ^@-?[0-9]+$ type: string Idempotent-Replayed: description: True when this response was replayed from an earlier attempt. schema: type: boolean Link: description: |- Links related to lifecycle or remediation documentation. Optional related resources. schema: type: string RateLimit: description: |- Current rate-limit state. Optional rate limit information. schema: type: string RateLimit-Policy: description: |- Rate-limit policy applied by the gateway. Optional rate limit policy. schema: type: string Retry-After: description: |- Delay before retrying, in seconds or as an HTTP date. Optional retry delay or HTTP date. schema: type: string Sunset: description: >- RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`. schema: pattern: >- ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$ type: string X-Request-ID: description: |- Identifier for this HTTP attempt. Application request identifier. schema: type: string X-Trace-ID: description: >- Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request. schema: pattern: ^(?!0{32}$)[0-9a-f]{32}$ type: string '502': content: application/problem+json: schema: $ref: '#/components/schemas/UpstreamFailureProblem' description: 'UPSTREAM_FAILURE: Upstream Service Failure' headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '503': content: application/problem+json: schema: $ref: '#/components/schemas/UpstreamUnavailableProblem' description: 'UPSTREAM_UNAVAILABLE: Upstream Service Unavailable' headers: Deprecation: description: >- RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`. schema: pattern: ^@-?[0-9]+$ type: string Idempotent-Replayed: description: True when this response was replayed from an earlier attempt. schema: type: boolean Link: description: |- Links related to lifecycle or remediation documentation. Optional related resources. schema: type: string RateLimit: description: |- Current rate-limit state. Optional rate limit information. schema: type: string RateLimit-Policy: description: |- Rate-limit policy applied by the gateway. Optional rate limit policy. schema: type: string Retry-After: description: |- Delay before retrying, in seconds or as an HTTP date. Optional retry delay or HTTP date. schema: type: string Sunset: description: >- RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`. schema: pattern: >- ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$ type: string X-Request-ID: description: |- Identifier for this HTTP attempt. Application request identifier. schema: type: string X-Trace-ID: description: >- Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request. schema: pattern: ^(?!0{32}$)[0-9a-f]{32}$ type: string '504': content: application/problem+json: schema: $ref: '#/components/schemas/CountMessagesGatewayTimeoutProblem' description: >- UPSTREAM_TIMEOUT: Upstream Service Timeout; REQUEST_TIMEOUT: Request Timeout headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' security: - accountServiceKey: [] - projectApiKey: [] - oauth2: - project:read components: schemas: MessageDirection: enum: - received - sent type: string Platform: enum: - sms - email - whatsapp - whatsapp_business - imessage - telegram type: string CountMessagesResponse: anyOf: - $ref: '#/components/schemas/MessageCount' - $ref: '#/components/schemas/DailyMessageCount' NotAuthenticatedProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: NOT_AUTHENTICATED status: 401 title: Not Authenticated type: https://photon.codes/docs/problems/not-authenticated properties: code: const: NOT_AUTHENTICATED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 401 type: number title: const: Not Authenticated type: string type: const: https://photon.codes/docs/problems/not-authenticated type: string required: - code - status - title - type type: object CountMessagesForbiddenProblem: oneOf: - $ref: '#/components/schemas/ForbiddenProblem' - $ref: '#/components/schemas/InsufficientScopeProblem' - $ref: '#/components/schemas/OrganizationSsoRequiredProblem' - $ref: '#/components/schemas/ResourceMismatchProblem' ValidationFailedProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: VALIDATION_FAILED issues: - code: invalid_type location: json message: Expected a string. path: /name status: 422 title: Request Validation Failed type: https://photon.codes/docs/problems/validation-failed properties: code: const: VALIDATION_FAILED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string issues: items: $ref: '#/components/schemas/ValidationIssue' type: array remediation: not: {} requestId: minLength: 1 type: string status: const: 422 type: number title: const: Request Validation Failed type: string type: const: https://photon.codes/docs/problems/validation-failed type: string required: - issues - code - status - title - type type: object CountMessagesInternalServerErrorProblem: oneOf: - $ref: '#/components/schemas/InternalErrorProblem' - $ref: '#/components/schemas/InvalidAuthContextProblem' UpstreamFailureProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: UPSTREAM_FAILURE status: 502 title: Upstream Service Failure type: https://photon.codes/docs/problems/upstream-failure properties: code: const: UPSTREAM_FAILURE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 502 type: number title: const: Upstream Service Failure type: string type: const: https://photon.codes/docs/problems/upstream-failure type: string required: - code - status - title - type type: object UpstreamUnavailableProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: UPSTREAM_UNAVAILABLE status: 503 title: Upstream Service Unavailable type: https://photon.codes/docs/problems/upstream-unavailable properties: code: const: UPSTREAM_UNAVAILABLE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 503 type: number title: const: Upstream Service Unavailable type: string type: const: https://photon.codes/docs/problems/upstream-unavailable type: string required: - code - status - title - type type: object CountMessagesGatewayTimeoutProblem: oneOf: - $ref: '#/components/schemas/UpstreamTimeoutProblem' - $ref: '#/components/schemas/RequestTimeoutProblem' MessageCount: additionalProperties: false properties: count: maximum: 9007199254740991 minimum: 0 type: integer groups: items: $ref: '#/components/schemas/MessageDirectionCount' type: array required: - count type: object DailyMessageCount: additionalProperties: false properties: buckets: items: $ref: '#/components/schemas/MessageCountBucket' type: array count: maximum: 9007199254740991 minimum: 0 type: integer groups: items: $ref: '#/components/schemas/MessageDirectionCount' type: array interval: const: day type: string timeZone: type: string required: - count - buckets - interval - timeZone type: object JsonValue: anyOf: - type: string - type: number - type: boolean - type: 'null' - items: $ref: '#/components/schemas/JsonValue' type: array - additionalProperties: $ref: '#/components/schemas/JsonValue' propertyNames: type: string type: object ForbiddenProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: FORBIDDEN status: 403 title: Forbidden type: https://photon.codes/docs/problems/forbidden properties: code: const: FORBIDDEN type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 403 type: number title: const: Forbidden type: string type: const: https://photon.codes/docs/problems/forbidden type: string required: - code - status - title - type type: object InsufficientScopeProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: INSUFFICIENT_SCOPE status: 403 title: Insufficient Scope type: https://photon.codes/docs/problems/insufficient-scope properties: code: const: INSUFFICIENT_SCOPE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 403 type: number title: const: Insufficient Scope type: string type: const: https://photon.codes/docs/problems/insufficient-scope type: string required: - code - status - title - type type: object OrganizationSsoRequiredProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: ORGANIZATION_SSO_REQUIRED status: 403 title: Organization SSO Required type: https://photon.codes/docs/problems/organization-sso-required properties: code: const: ORGANIZATION_SSO_REQUIRED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 403 type: number title: const: Organization SSO Required type: string type: const: https://photon.codes/docs/problems/organization-sso-required type: string required: - code - status - title - type type: object ResourceMismatchProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: RESOURCE_MISMATCH status: 403 title: Resource Mismatch type: https://photon.codes/docs/problems/resource-mismatch properties: code: const: RESOURCE_MISMATCH type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 403 type: number title: const: Resource Mismatch type: string type: const: https://photon.codes/docs/problems/resource-mismatch type: string required: - code - status - title - type type: object ValidationIssue: additionalProperties: false properties: code: minLength: 1 type: string location: $ref: '#/components/schemas/ValidationLocation' message: minLength: 1 type: string path: type: string required: - code - location - message - path type: object InternalErrorProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: INTERNAL_ERROR status: 500 title: Internal Server Error type: https://photon.codes/docs/problems/internal-error properties: code: const: INTERNAL_ERROR type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 500 type: number title: const: Internal Server Error type: string type: const: https://photon.codes/docs/problems/internal-error type: string required: - code - status - title - type type: object InvalidAuthContextProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: INVALID_AUTH_CONTEXT status: 500 title: Invalid Authentication Context type: https://photon.codes/docs/problems/invalid-auth-context properties: code: const: INVALID_AUTH_CONTEXT type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 500 type: number title: const: Invalid Authentication Context type: string type: const: https://photon.codes/docs/problems/invalid-auth-context type: string required: - code - status - title - type type: object UpstreamTimeoutProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: UPSTREAM_TIMEOUT status: 504 title: Upstream Service Timeout type: https://photon.codes/docs/problems/upstream-timeout properties: code: const: UPSTREAM_TIMEOUT type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 504 type: number title: const: Upstream Service Timeout type: string type: const: https://photon.codes/docs/problems/upstream-timeout type: string required: - code - status - title - type type: object RequestTimeoutProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: REQUEST_TIMEOUT status: 504 title: Request Timeout type: https://photon.codes/docs/problems/request-timeout properties: code: const: REQUEST_TIMEOUT type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 504 type: number title: const: Request Timeout type: string type: const: https://photon.codes/docs/problems/request-timeout type: string required: - code - status - title - type type: object MessageDirectionCount: additionalProperties: false properties: count: maximum: 9007199254740991 minimum: 0 type: integer direction: $ref: '#/components/schemas/MessageDirection' required: - count - direction type: object MessageCountBucket: additionalProperties: false properties: count: maximum: 9007199254740991 minimum: 0 type: integer end: format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ type: string groups: items: $ref: '#/components/schemas/MessageDirectionCount' type: array start: format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ type: string required: - count - end - start type: object ValidationLocation: enum: - body - cookie - form - header - json - param - query type: string headers: Deprecation: description: >- RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`. schema: pattern: ^@-?[0-9]+$ type: string Idempotent-Replayed: description: True when this response was replayed from an earlier attempt. schema: type: boolean Link: description: Links related to lifecycle or remediation documentation. schema: type: string RateLimit: description: Current rate-limit state. schema: type: string RateLimit-Policy: description: Rate-limit policy applied by the gateway. schema: type: string Retry-After: description: Delay before retrying, in seconds or as an HTTP date. schema: type: string Sunset: description: >- RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`. schema: pattern: >- ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$ type: string X-Request-ID: description: Identifier for this HTTP attempt. schema: type: string X-Trace-ID: description: >- Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request. schema: pattern: ^(?!0{32}$)[0-9a-f]{32}$ type: string securitySchemes: accountServiceKey: description: >- Account Service Key, prefixed with `pho_ask_`, sent as `Authorization: Bearer `. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted. scheme: bearer type: http projectApiKey: description: >- Project API key, `pho_sk_` prefixed, sent as `Authorization: Bearer `. Bound to one project, so it is accepted only under `/v1/projects/{projectId}` and refused everywhere else. scheme: bearer type: http oauth2: description: >- OAuth grant issued by the Photon authorization server. The token is a bearer JWT whose consented scope is intersected with the permissions the route grants; an empty intersection is `403 insufficient_scope`. flows: authorizationCode: authorizationUrl: https://auth.photon.codes/oauth2/authorize scopes: account:create_project: Create a project owned by the account. account:read: View account profile. account:read_projects: >- List projects associated with the account; does not grant access to project contents. account:write: Update account name and profile. billing:read: View invoices, usage, payment status. events:read: >- Query stored Events and discover their SQL schema within a project. organization:create_project: Create a project in the organization. organization:read: View organization name and avatar. organization:read_projects: List projects in the organization. platforms:read: View project platform configuration. platforms:write: Change project platform configuration. project:delete: Permanently delete the project. project:read: View non-sensitive project settings. project:read_usage: View project usage and costs. project:write: >- Change agent profiles, webhook settings, and other project configuration. ten_dlc:read: View organization 10DLC Brand and Campaign registration records. ten_dlc:write: >- Register and update organization 10DLC Brands and Campaigns, including OTP operations. tokenUrl: https://auth.photon.codes/oauth2/token type: oauth2 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.