> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trylath.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Every Lath operation is POST https://platform.trylath.com/<operation name with dots replaced by slashes>, with a JSON body and `Authorization: Bearer <key>`. `email.send` is POST /email/send.
> Branch on `error.code`, never on `error.message`. Every refusal also carries `error.fix`, which names the next step.
> Send an `Idempotency-Key` header on any operation that is not retry-safe, so a retry cannot run it twice.
> A `lath_test_` key emails only the account's own members and sends no SMS; a `lath_live_` key reaches real recipients and is billed.
> The OpenAPI document, generated from the same registry as the routes, is at https://platform.trylath.com/openapi.json.

# audience.segment.create

> Saves a segment: a named filter over contacts by property, address, consent and creation time.



## OpenAPI

````yaml /api-reference/openapi.json post /audience/segment/create
openapi: 3.1.0
info:
  title: Lath API
  version: 0.1.0
  description: >-
    Every operation is one POST. The same set is reachable over MCP, the SDK and
    the CLI; nothing is dashboard-only.
servers:
  - url: https://platform.trylath.com
    description: This deployment
security: []
paths:
  /audience/segment/create:
    post:
      tags:
        - audience
      summary: audience.segment.create
      description: >-
        Saves a segment: a named filter over contacts by property, address,
        consent and creation time.
      operationId: audience.segment.create
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
          description: >-
            Replays the stored response for the same key and input; refuses
            different input.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                definition:
                  type: object
                  properties:
                    all:
                      maxItems: 50
                      type: array
                      items:
                        anyOf:
                          - type: object
                            properties:
                              property:
                                type: string
                                pattern: ^[a-zA-Z0-9_]{1,64}$
                              op:
                                type: string
                                enum:
                                  - eq
                                  - neq
                                  - contains
                                  - gt
                                  - lt
                              value:
                                type:
                                  - string
                                  - number
                                  - boolean
                            required:
                              - property
                              - op
                              - value
                            additionalProperties: false
                          - type: object
                            properties:
                              property:
                                type: string
                                pattern: ^[a-zA-Z0-9_]{1,64}$
                              op:
                                type: string
                                enum:
                                  - exists
                                  - missing
                            required:
                              - property
                              - op
                            additionalProperties: false
                          - type: object
                            properties:
                              has:
                                type: string
                                enum:
                                  - email
                                  - phone
                            required:
                              - has
                            additionalProperties: false
                          - type: object
                            properties:
                              consent:
                                type: object
                                properties:
                                  channel:
                                    type: string
                                    enum:
                                      - email
                                      - sms
                                  topic:
                                    type: string
                                    pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
                                required:
                                  - channel
                                  - topic
                                additionalProperties: false
                            required:
                              - consent
                            additionalProperties: false
                          - type: object
                            properties:
                              createdBefore:
                                type: string
                                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)))$
                            required:
                              - createdBefore
                            additionalProperties: false
                          - type: object
                            properties:
                              createdAfter:
                                type: string
                                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)))$
                            required:
                              - createdAfter
                            additionalProperties: false
                    any:
                      maxItems: 50
                      type: array
                      items:
                        anyOf:
                          - type: object
                            properties:
                              property:
                                type: string
                                pattern: ^[a-zA-Z0-9_]{1,64}$
                              op:
                                type: string
                                enum:
                                  - eq
                                  - neq
                                  - contains
                                  - gt
                                  - lt
                              value:
                                type:
                                  - string
                                  - number
                                  - boolean
                            required:
                              - property
                              - op
                              - value
                            additionalProperties: false
                          - type: object
                            properties:
                              property:
                                type: string
                                pattern: ^[a-zA-Z0-9_]{1,64}$
                              op:
                                type: string
                                enum:
                                  - exists
                                  - missing
                            required:
                              - property
                              - op
                            additionalProperties: false
                          - type: object
                            properties:
                              has:
                                type: string
                                enum:
                                  - email
                                  - phone
                            required:
                              - has
                            additionalProperties: false
                          - type: object
                            properties:
                              consent:
                                type: object
                                properties:
                                  channel:
                                    type: string
                                    enum:
                                      - email
                                      - sms
                                  topic:
                                    type: string
                                    pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
                                required:
                                  - channel
                                  - topic
                                additionalProperties: false
                            required:
                              - consent
                            additionalProperties: false
                          - type: object
                            properties:
                              createdBefore:
                                type: string
                                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)))$
                            required:
                              - createdBefore
                            additionalProperties: false
                          - type: object
                            properties:
                              createdAfter:
                                type: string
                                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)))$
                            required:
                              - createdAfter
                            additionalProperties: false
                    none:
                      maxItems: 50
                      type: array
                      items:
                        anyOf:
                          - type: object
                            properties:
                              property:
                                type: string
                                pattern: ^[a-zA-Z0-9_]{1,64}$
                              op:
                                type: string
                                enum:
                                  - eq
                                  - neq
                                  - contains
                                  - gt
                                  - lt
                              value:
                                type:
                                  - string
                                  - number
                                  - boolean
                            required:
                              - property
                              - op
                              - value
                            additionalProperties: false
                          - type: object
                            properties:
                              property:
                                type: string
                                pattern: ^[a-zA-Z0-9_]{1,64}$
                              op:
                                type: string
                                enum:
                                  - exists
                                  - missing
                            required:
                              - property
                              - op
                            additionalProperties: false
                          - type: object
                            properties:
                              has:
                                type: string
                                enum:
                                  - email
                                  - phone
                            required:
                              - has
                            additionalProperties: false
                          - type: object
                            properties:
                              consent:
                                type: object
                                properties:
                                  channel:
                                    type: string
                                    enum:
                                      - email
                                      - sms
                                  topic:
                                    type: string
                                    pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
                                required:
                                  - channel
                                  - topic
                                additionalProperties: false
                            required:
                              - consent
                            additionalProperties: false
                          - type: object
                            properties:
                              createdBefore:
                                type: string
                                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)))$
                            required:
                              - createdBefore
                            additionalProperties: false
                          - type: object
                            properties:
                              createdAfter:
                                type: string
                                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)))$
                            required:
                              - createdAfter
                            additionalProperties: false
                  additionalProperties: false
              required:
                - name
                - definition
              additionalProperties: false
      responses:
        '200':
          description: '{ activityId, result }. activityId is empty for reads.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  activityId:
                    type: string
                    description: The activity this call created, or empty for a read.
                  result:
                    $schema: https://json-schema.org/draft/2020-12/schema
                    type: object
                    properties:
                      segment:
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                            pattern: >-
                              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                          name:
                            type: string
                          definition: {}
                          createdAt:
                            type: string
                            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)))$
                          updatedAt:
                            type: string
                            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)))$
                        required:
                          - id
                          - name
                          - definition
                          - createdAt
                          - updatedAt
                        additionalProperties: {}
                    required:
                      - segment
                    additionalProperties: {}
                required:
                  - activityId
                  - result
        '400':
          description: invalid_input or invalid_json
        '401':
          description: unauthenticated
        '403':
          description: forbidden
        '404':
          description: not_found
        '409':
          description: 'conflict: idempotency_mismatch, email_taken, last_key'
        '413':
          description: body_too_large
        '429':
          description: rate_limited
      security:
        - bearer: []
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        A Lath API key: lath_live_sk… or lath_test_sk… on a server,
        lath_live_pk… or lath_test_pk… in a browser.

````