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

# Read a write of one contact's samples

> Read a press of Write the email (`POST /sequences/{sequence_id}/steps/{step_id}/rows/{record_id}/samples/`) as it stands. `queued` and `running` while the agent writes; `done` with `rendered`, the step pressed as the contact would receive it, read now; `failed` with `error`, nothing written for the step and its previews given back to today's allowance. A write still open past its deadline reads as `failed`. Writes are kept a week.



## OpenAPI

````yaml /openapi.json get /sequences/{sequence_id}/sample-runs/{run_id}/
openapi: 3.1.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: >-
    REST API reference for Oneprofile, the GTM data layer for your CRM. Manage
    tables, enrichments, and integrations. Authenticate with an API key to get
    started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: API Reference | Oneprofile
  version: '0.0'
servers:
  - url: https://api.getoneprofile.ai
security: []
tags:
  - description: >-
      The docked AI Assistant: its general chat about the workspace and the
      product, streamed as Server-Sent Events, and the one list of a person's
      threads across every assistant, with pin, rename, delete and the
      search-to-table link, and the read of a web page a person links.
    name: assistant
  - description: >-
      The messages a person keeps to send the assistant again: the ones the
      workspace saved and the ones that ship with the product, with save,
      rename, edit and delete.
    name: assistant-prompt
  - description: >-
      Granted workspace actions: what the AI Assistant proposed or applied in a
      conversation, the approve and dismiss decisions on each card, the
      workspace's spend threshold and default grants, and the eight verbs.
    name: workspace-actions
  - description: >-
      The Getting started checklist: a workspace's progress through the six
      steps from its first people search to its first launched sequence.
    name: onboarding
  - description: Senders, connected mailboxes, tags, and the Google connect flow.
    name: senders
  - description: The workspace do-not-contact list, enforced before every send.
    name: suppression
  - description: >-
      The workspace's recontact rule: how long before anyone hears from us
      again.
    name: contact_cooldown
  - description: 'Sequence authoring: the graph, the table-backed audience, previews.'
    name: sequences
  - description: >-
      The outbound agent behind a sequence: the voice it writes in, its
      per-message prompts, what it wrote and what people told it.
    name: outbound-agents
  - description: >-
      The LinkedIn channel: connecting an account to a sender, its safety limits
      and history, and the protocol the browser extension speaks.
    name: linkedin
  - description: >-
      The approval queue: everything waiting on a person across every sender and
      channel, and the workspace's manual or automatic modes per channel.
    name: outreach
  - description: 'The unified outreach inbox: threads, replies, labels, events.'
    name: inbox
  - description: 'The AI reply layer: workspace settings, drafts, and approval.'
    name: inbox-ai
  - description: Notification rules, per-user preferences, and the Slack connection.
    name: notifications
  - description: Endpoints for seeing all available integration types.
    name: integration-types
  - description: Endpoints for listing, checking and deleting integrations.
    name: integrations
  - description: >-
      Create, preview and update an integration of any type: the body's
      integration_type picks the config and credentials it takes.
    name: integration-specific
  - description: Endpoints for the generic OAuth install/claim app-listings engine.
    name: app-listings
  - description: Endpoints for creating and managing API keys.
    name: apikey
  - description: >-
      AI apps connected to the workspace: Claude, ChatGPT, Claude Code or any
      other MCP client a person signed in to Oneprofile's MCP server with.
    name: ai_apps
  - description: Endpoints for managing billing and subscription information.
    name: billing
  - description: >-
      Accounts: every company the workspace's tables name, with the people at
      it, its key facts, its tables, its org chart and what went to its people;
      the tables that feed it (Sources) and the merges a person made.
    name: accounts
  - description: Endpoints for creating and managing tables.
    name: tables
  - description: Endpoints for table columns, formula previews, and on-demand column runs.
    name: table-columns
  - description: Endpoints for table rows and manual cell edits.
    name: table-rows
  - description: Endpoints for observing and cancelling table recompute runs.
    name: table-runs
  - description: >-
      Endpoints for org-shared per-column display preferences: hidden, pinned,
      width, and color tint.
    name: table-ui-prefs
  - description: >-
      Endpoints for the org-shared names given to the column tint palette: what
      this organization calls each color. Org-level, not per-table.
    name: table-column-color-labels
  - description: >-
      Endpoints for the enrichment action catalog, model list, presets, draft
      generation, and saved agents.
    name: table-enrichments
  - description: >-
      Endpoints for an agent's Preview: example rows run one at a time, and a
      Looks good on each. Needs work lives under agent-learnings.
    name: agent-training
  - description: >-
      An agent's learnings, the one-line rules it follows on every output, and
      the thumbs down that teaches them: give one with what was wrong, list the
      ones on a subject, Undo one, and price the redo it would run.
    name: agent-learnings
  - description: >-
      The durable audit trail of a table's enrichment actions: configured,
      edited, run, cancelled, and settled cost.
    name: table-enrichment-audit-logs
  - description: Endpoints for saving and applying column templates.
    name: table-templates
  - description: Server-sent change feed for a table's grid.
    name: table-events
  - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.'
    name: table-views
  - description: >-
      Endpoints for PER-USER table preferences: favorites and recently opened.
      Unlike the rest of the table surface these are personal, so two members of
      one organization legitimately see different answers.
    name: table-user-prefs
  - description: >-
      Endpoints for building a table from an uploaded CSV: upload and preview
      the inferred columns, commit the reviewed mapping, then poll the row load.
    name: table-imports
  - description: Endpoint for downloading a table's rows as CSV.
    name: table-export
  - description: >-
      Endpoints for the integration a table imports from: attach and preview it,
      promote imported fields into columns, and run the import on demand.
    name: table-sources
  - description: >-
      Endpoints for the webhook URL an app or a tool of your own sends records
      to: what can send them, make the URL, show it again, replace it, revoke
      it, save the app's secrets, resume a paused feed, and read and retry the
      deliveries that did not fit.
    name: table-webhooks
  - description: >-
      Endpoints for a table's recurring import cadence: set it, pause it, and
      read the next fire times.
    name: table-schedules
  - description: >-
      Endpoints for pushing a table's rows out to a connected integration: list
      writable destinations, derive their write capabilities, and map export
      columns.
    name: table-writeback
  - description: >-
      Endpoints backing a lookup column's setup: the connections whose records a
      column could read, and the identity fields one record type can be looked
      up by.
    name: table-integration-lookup
  - description: >-
      Endpoints for sourcing leads from the lead database: count and preview
      matches, land them in a table, and keep saved searches. Alongside people
      and company searches, leads can be sourced from buying signals (what a
      company or person just did), with a catalog endpoint behind the picker
      that builds them.
    name: find-leads
  - description: >-
      Endpoints for discovering a domain's subdomains from public certificate
      logs and landing the results in a table.
    name: find-subdomains
  - description: Endpoints for the credit balance meter and usage reporting.
    name: credits
  - description: >-
      Endpoints for the workspace referral program: the shareable link, the
      friends who joined through it, and claiming a code after signup.
    name: referral
  - description: >-
      Endpoints for the affiliate program's own dashboard: enrolling and
      claiming a code, the summary, stats and activity feed, the commission
      ledger, and identity verification and payouts.
    name: affiliate
  - description: >-
      Endpoints for recording where a new workspace came from: the marketing
      page or campaign its signup link carried, sent once after signup.
    name: attribution
  - description: >-
      Endpoints for the design partner program's customer surface: whether this
      workspace is a design partner, the badges its feedback has earned, and
      sending and reading that feedback.
    name: design-partner
  - description: >-
      Endpoints for the org-level AI business context (company description,
      ideal customer profile, buyer personas, interest signals and social
      proof), plus domain-based generation and the reference documents whose
      summaries ride alongside those fields.
    name: ai-context
  - description: >-
      Endpoints for the signed-in user's Google Drive connection: starting and
      finishing the OAuth grant, checking or dropping it, and minting the
      short-lived token the Google Picker needs.
    name: google-drive
paths:
  /sequences/{sequence_id}/sample-runs/{run_id}/:
    get:
      tags:
        - sequences
      summary: Read a write of one contact's samples
      description: >-
        Read a press of Write the email (`POST
        /sequences/{sequence_id}/steps/{step_id}/rows/{record_id}/samples/`) as
        it stands. `queued` and `running` while the agent writes; `done` with
        `rendered`, the step pressed as the contact would receive it, read now;
        `failed` with `error`, nothing written for the step and its previews
        given back to today's allowance. A write still open past its deadline
        reads as `failed`. Writes are kept a week.
      operationId: get_sequence_sample_run
      parameters:
        - in: path
          name: sequence_id
          required: true
          schema:
            format: uuid
            title: Sequence Id
            type: string
        - in: path
          name: run_id
          required: true
          schema:
            format: uuid
            title: Run Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SampleWriteRunReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not found.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    SampleWriteRunReadSchema:
      description: One press of Write the email for one contact, written in the background.
      properties:
        created_at:
          format: date-time
          title: Created At
          type: string
        error:
          anyOf:
            - type: string
            - type: 'null'
          description: What to tell a person; null unless failed.
          title: Error
        error_code:
          anyOf:
            - $ref: '#/components/schemas/SampleWriteErrorCode'
            - type: 'null'
          description: >-
            Why it failed: `not_written` (the agent wrote nothing usable),
            `timed_out`, `lost` (it stopped before it finished), `gone` (the
            contact or step changed meanwhile) or `error`. Null unless failed.
        finished_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When it ended; null while open.
          title: Finished At
        id:
          description: The write, which `GET .../sample-runs/{run_id}/` reads.
          format: uuid
          title: Id
          type: string
        record_id:
          description: The contact's audience row.
          format: uuid
          title: Record Id
          type: string
        rendered:
          anyOf:
            - $ref: '#/components/schemas/RenderedMessageReadSchema'
            - type: 'null'
          description: >-
            The step pressed as the contact would receive it, read when the
            write is `done`, as `GET
            /sequences/{sequence_id}/steps/{step_id}/preview/` shows it. Null
            until then.
        sequence_id:
          format: uuid
          title: Sequence Id
          type: string
        state:
          $ref: '#/components/schemas/SampleWriteRunState'
          description: >-
            `queued` and `running` while the agent writes; `done` once the step
            pressed has words, in `rendered`; `failed` when nothing was written
            for it, with `error` saying why. A failed write's previews go back
            to today's allowance.
        step_id:
          description: The step pressed, which `rendered` shows.
          format: uuid
          title: Step Id
          type: string
        step_ids:
          description: >-
            The steps the write covers, in order: the contact's whole sequence,
            or the step pressed alone while another of their emails is marked
            Looks good, or the step pressed when its words were already there.
          items:
            format: uuid
            type: string
          title: Step Ids
          type: array
      required:
        - id
        - sequence_id
        - record_id
        - step_id
        - step_ids
        - state
        - created_at
      title: SampleWriteRunReadSchema
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
        - detail
      title: UnauthorizedResponse
      type: object
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
        - detail
      title: ForbiddenResponse
      type: object
    NotFoundResponse:
      properties:
        detail:
          description: The detail of why the resource was not found.
          title: Detail
          type: string
      required:
        - detail
      title: NotFoundResponse
      type: object
    UnprocessableEntityResponse:
      properties:
        detail:
          description: >-
            The detail of the error. This is the error message to show to the
            user. You should also use the issues field to show more detailed
            error messages per field. Use this field for a single liner error
            message.
          title: Detail
          type: string
        issues:
          description: >-
            The issues that caused the error. There can be multiple issues. Each
            issue is a user-facing error message.
          items:
            $ref: '#/components/schemas/UnprocessableEntityIssue'
          title: Issues
          type: array
      required:
        - detail
        - issues
      title: UnprocessableEntityResponse
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
        - detail
      title: ServerErrorResponse
      type: object
    SampleWriteErrorCode:
      description: >-
        Why a sample write ended failed; the dashboard and the AI Assistant read
        ``error``.
      enum:
        - not_written
        - timed_out
        - lost
        - gone
        - error
      title: SampleWriteErrorCode
      type: string
    RenderedMessageReadSchema:
      properties:
        agent_written:
          default: false
          description: >-
            The agent wrote this for the contact. A preview is one draft; the
            real send is written fresh, unless `approved`.
          title: Agent Written
          type: boolean
        approved:
          default: false
          description: >-
            The words were marked Looks good, with the contact's thread in the
            sequence's Preview or as this one email from the Builder, and still
            stand, so they are what sends. They stop standing, and the agent
            writes the step fresh, once the agent's writing or the contact's row
            changes.
          title: Approved
          type: boolean
        body:
          title: Body
          type: string
        closing:
          anyOf:
            - $ref: '#/components/schemas/EmailClosingReadSchema'
            - type: 'null'
          description: >-
            What the send adds below these words, the sender's signature and
            then the opt-out footer, one blank line apart, so the email can be
            shown whole as the contact will get it. Set by the preview routes on
            an email step.
        in_thread:
          title: In Thread
          type: boolean
        is_sample:
          default: false
          title: Is Sample
          type: boolean
        message_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: >-
            The agent's message these words are, on an agent-written step: the
            sample on screen, or the one marked Looks good. Marking it Looks
            good (`PUT
            /sequences/{sequence_id}/steps/{step_id}/rows/{record_id}/feedback/`)
            takes it back as `message_id`, so a mark lands only on the words
            that were read.
          title: Message Id
        missing_columns:
          items:
            type: string
          title: Missing Columns
          type: array
        pinned:
          default: false
          description: >-
            The words are pinned for this contact by a person (their own edit)
            or by the approval queue, and send exactly as they are. A thread
            marked Looks good is `approved` instead.
          title: Pinned
          type: boolean
        preview_units:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            With `written` false: how much of today's preview allowance writing
            it would use, one for each message the agent writes in the call (the
            contact's whole sequence for a contact not written to yet). Writing
            is refused when `GET /outbound-agents/preview-allowance/` has fewer
            `remaining`. Null otherwise, or when it cannot be worked out.
          title: Preview Units
        sample_created_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Sample Created At
        sample_version:
          anyOf:
            - type: integer
            - type: 'null'
          title: Sample Version
        sent:
          anyOf:
            - $ref: '#/components/schemas/SentStepEmailReadSchema'
            - type: 'null'
          description: >-
            The email this step already got out to this contact, as it went,
            when one did: what they received, whoever wrote it, rather than the
            words above. Set by the preview and samples routes; null when the
            step has not reached them.
        spam_findings:
          description: >-
            The spam check and the placeholder scan, run on the agent's words
            for this contact. Always empty for a written step, whose text the
            composer's own check covers. Advice, never a refusal.
          items:
            $ref: '#/components/schemas/SpamFindingReadSchema'
          title: Spam Findings
          type: array
        subject:
          title: Subject
          type: string
        waiting_for_approval:
          default: false
          description: >-
            This contact's message at this step waits for a person's approval on
            its Tasks card, where its words are changed, approved or rejected.
            Set by the preview and samples routes; false once the card is
            decided, or when the step never asked.
          title: Waiting For Approval
          type: boolean
        writing_run_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: >-
            The agent is writing this contact's emails right now, this step
            among them: the write's id, which `GET
            /sequences/{sequence_id}/sample-runs/{run_id}/` follows until it
            ends. Whoever pressed Write the email, in whatever tab. Set by the
            step's preview; null when nothing is being written for this step.
          title: Writing Run Id
        written:
          default: true
          description: >-
            False only when nothing is written for this contact at this step
            yet, which the step's preview shows rather than writes: subject and
            body are empty. `POST
            /sequences/{sequence_id}/steps/{step_id}/rows/{record_id}/samples/`
            has the agent write it.
          title: Written
          type: boolean
      required:
        - subject
        - body
        - missing_columns
        - in_thread
      title: RenderedMessageReadSchema
      type: object
    SampleWriteRunState:
      description: >-
        Where one press of Write the email stands
        (``sequence_sample_write_run.state``, ONE-1631).


        ``QUEUED`` is committed and waits for its workflow to pick it up;
        ``RUNNING``

        is the agent writing the contact's samples; ``DONE`` ended with words to
        show

        (written now, or already there when pressed); ``FAILED`` ended with
        nothing

        written for the step, its error said, its free previews given back.
      enum:
        - queued
        - running
        - done
        - failed
      title: SampleWriteRunState
      type: string
    UnprocessableEntityIssue:
      properties:
        input:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - items: {}
              type: array
            - additionalProperties: true
              type: object
          description: The user's input that caused the error.
          title: Input
        loc:
          description: >-
            The location of the error. Always contains 1 or 2 elements. The
            first element is the type of location (e.g. 'body', 'query', 'path',
            'header'). The second element is the name of the field that caused
            the error. If the error is not related to a specific field, the
            second element is not present.
          items:
            type: string
          title: Loc
          type: array
        msg:
          description: The message of the error. The error message to show to the user.
          title: Msg
          type: string
        type:
          description: >-
            The type of the error. Useful for frontend code to handle different
            types of errors.
          title: Type
          type: string
      required:
        - loc
        - msg
        - type
        - input
      title: UnprocessableEntityIssue
      type: object
    EmailClosingReadSchema:
      description: >-
        What a send adds below an email's words: the sender's signature, then
        the opt-out footer.
      properties:
        opt_out_footer:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The sequence's opt-out footer, last of all, as the email carries it:
            its unsubscribe link written `[unsubscribe here](url)` in a
            formatted sequence and as the bare URL in a plain-text one. In a
            preview the link unsubscribes nobody. Null when the sequence has no
            footer.
          title: Opt Out Footer
        signature:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The signature the email ends with, its sender variables filled in as
            the send fills them: the mailbox about to send, or else the first
            sender, the sender a preview writes as. Null when the sender has
            none.
          title: Signature
      required:
        - signature
        - opt_out_footer
      title: EmailClosingReadSchema
      type: object
    SentStepEmailReadSchema:
      description: The email a step got out to one contact, as it went.
      properties:
        body:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The email's words as they were sent, without the signature and
            opt-out footer the send added below them.
          title: Body
        email_html:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The email's HTML part exactly as it was handed to Gmail: the words,
            the sender's signature and the opt-out footer, every line, blank
            line and space as the contact got them. Null for a send from before
            the send kept its email.
          title: Email Html
        sent_at:
          format: date-time
          title: Sent At
          type: string
        subject:
          anyOf:
            - type: string
            - type: 'null'
          title: Subject
      required:
        - subject
        - body
        - sent_at
      title: SentStepEmailReadSchema
      type: object
    SpamFindingReadSchema:
      properties:
        code:
          title: Code
          type: string
        detail:
          description: 'The evidence: "3 in the message. One is safest, two at most."'
          title: Detail
          type: string
        excerpt:
          anyOf:
            - type: string
            - type: 'null'
          title: Excerpt
        excerpts:
          description: Every piece of text the finding is about; excerpt is the first.
          items:
            type: string
          title: Excerpts
          type: array
        message:
          description: Title and detail as one sentence, for a single line.
          title: Message
          type: string
        severity:
          description: warning (likely hurts) or info (worth knowing).
          title: Severity
          type: string
        title:
          description: 'The problem, named: "Too many links".'
          title: Title
          type: string
      required:
        - code
        - severity
        - title
        - detail
        - message
      title: SpamFindingReadSchema
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    HTTPBearer:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.