---
title: "Get a Sentence"
method: GET
path: "/v2.0/locales/{localeId}/yesnointents/{intentId}/sentences/{sentenceId}"
tags: ["Yes/No Intents"]
---

# Get a Sentence

`GET /v2.0/locales/{localeId}/yesnointents/{intentId}/sentences/{sentenceId}`

## Request

- Base URL: `https://api-trial.cognigy.ai/testing`
- URL: `https://api-trial.cognigy.ai/testing/v2.0/locales/{localeId}/yesnointents/{intentId}/sentences/{sentenceId}`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in query parameter `api_key`
  - API key in header `x-cxone-authorization`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Password
    - Token URL: `/auth/oauth2/token`
- TypeScript: <https://skmtc.dev/cognigy/apis/simulator-openapi-rest-ful-api-reference/docs/v2.0/locales/:localeId/yesnointents/:intentId/sentences/:sentenceId/get.ts> (a function with typed inputs; its response is checked against the schema)

Gets a Sentence from a Yes/No Intent.

## Path parameters

- `localeId` string, required
- `intentId` string, required
- `sentenceId` string, required

## Headers

- `Accept` 'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

## Response `200`

Returns Sentence Object

- object: The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.
  - `localeReference` string
  - `feedbackReport` object
    - `findings` object[]
      - `type` 'poorScore' | 'fairScore' | 'goodScore' | 'overlap' | 'wrongIntent'
    - `info` object
      - `trueIntent` string
      - `topIntent` string
      - `runnerUp` string
      - `topScore` number
      - `runnerUpScore` number
      - `difference` number
      - `trueIntentName` string
      - `topIntentName` string
      - `runnerUpIntentName` string
  - `text` string: The text in the Example Sentence.
  - `slots` union[]: The Slot segments in the Example Sentence. Each item defines a start and end indexes, and the Slot type: system-defined or user-defined Slot.
    - union
      - object: A Slot defined by the start and end indexes in the Example Sentence. The value is the text that appears in the range between the start and end indexes.
        - `type` 'anySlot': The identifier for the Slot type.
        - `name` string: The display name of the Slot.
        - `start` number: The start index of the Slot in the Example Sentence text.
        - `end` number: The end index of the Slot in the Example Sentence text.
      - object: A system-defined Slot that references a system-defined data.
        - `type` 'systemSlot': The identifier for the Slot type.
        - `dimension` string: The system-defined data type.
        - `start` number: The start index of the Slot in the Example Sentence text.
        - `end` number: The end index of the Slot in the Example Sentence text.
      - object: The user-defined Slot.
        - `type` 'lexiconSlot': The identifier for the Slot type.
        - `lexiconReference` string
        - `slotReference` string
        - `name` string: The display name of the Slot.
        - `start` number: The start index of the Slot in the Example Sentence text.
        - `end` number: The end index of the Slot in the Example Sentence text.
  - `_id` string
  - `createdAt` integer: Unix-timestamp
  - `lastChanged` integer: Unix-timestamp
  - `createdBy` string
  - `lastChangedBy` string

## Other responses

- `400`: The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)
- `401`: The request has not been applied because it lacks valid authentication credentials for the target resource.
- `402`: Upgrade your Plan to increase your Quota.
- `403`: The server understood the request but refuses to authorize it.
- `404`: The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
- `405`: The method received in the request-line is known by the origin server but not supported by the target resource.
- `409`: The request conflicts with current state of the server.
- `413`: The request entity is larger than limits defined by server.
- `500`: The server encountered an unexpected condition that prevented it from fulfilling the request.
- `501`: The server does not support the functionality required to fulfill the request.
- `502`: The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
- `503`: The server is not ready to handle the request.
- `504`: The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.

---

[API](https://skmtc.dev/cognigy/apis/simulator-openapi-rest-ful-api-reference.md) - [All operations](https://skmtc.dev/cognigy/apis/simulator-openapi-rest-ful-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/cognigy/apis/simulator-openapi-rest-ful-api-reference/revisions/85b2872bdfb7?raw)