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

# List supported regions

> 프롬프트 실행 요청(submitRun)의 region 값으로 사용할 수 있는 지원 리전 목록을 조회합니다. model 을 지정하면 해당 모델이 지원하는 리전만, 생략하면 전체 리전을 반환합니다.
계약이 필요한 리전은 이 조직에 부여된 경우에만 목록에 포함됩니다.

### 오류

| HTTP | 코드 | 설명 |
| --- | --- | --- |
| 400 | `MODEL_NOT_SUPPORTED` | 플랫폼 API 가 지원하지 않는 model 값 |
| 400 | `MODEL_DISCONTINUED` | 서비스가 중단된 모델을 지정함 (현재 중단된 모델은 없음) |
| 401 | `COMMON_UNAUTHORIZED` | API 키 또는 액세스 토큰이 없거나 유효하지 않음 |
| 402 | `INSUFFICIENT_CREDITS` | 조직 크레딧 잔액이 이 요청의 단가보다 적음 |
| 429 | `PLATFORM_RATE_LIMIT_EXCEEDED` | 요청 한도 초과. `Retry-After` 헤더의 초만큼 기다린 뒤 재시도 |
| 500 | — | 서버 내부 오류. `code` 없이 `message` 와 `requestID` 를 반환 |



## OpenAPI

````yaml openapi.en.json GET /v1/platform/regions
openapi: 3.1.0
info:
  description: >-
    Platform API for external partners. Uses organization API key based
    authentication.

    ### Common request limits

    - The request body size is limited to 2MiB. Exceeding it returns 413 with
    the `COMMON_REQUEST_BODY_TOO_LARGE` code.

    - Array parameters and string fields have per-endpoint count and length
    limits. The limits are stated in each field or parameter description, and
    violating them returns 400 with the `COMMON_VALIDATION` code.

    ### Error responses

    The error response body always has the same three fields regardless of the
    status code.

    | Field | Type | Meaning |

    | --- | --- | --- |

    | `code` | string | A fixed identifier for the error type. This is the only
    value clients should branch on. The codes each endpoint returns are listed
    in the "Errors" table of that API. |

    | `message` | string | A human-readable, one-line summary of the whole
    error. There is always exactly one. |

    | `details` | array of strings | Individual reasons that do not fit in the
    single `message` line. Even a single reason is returned as an array of
    length 1, and the field is omitted when there is nothing to include. |

    - `details` is an array in every error. It is never returned as a string or
    an object, so no type-based branching is needed.

    - The wording of `details` is not a fixed contract. Use it only for display
    and debugging, and do not parse the strings to branch. Branch on `code`
    instead.

    - `details` is the only field that carries multiple reasons. There is no
    `messages` field in the response.

    - On validation failure (`COMMON_VALIDATION`), `details` contains one
    `"field: reason"` line per violated field. Example:
    `{"code":"COMMON_VALIDATION","message":"Data validation
    failed","details":["keywords: up to 100 items can be entered"]}`

    - `message` defaults to Korean and is returned in English when you send
    `Accept-Language: en`. `details` follows the same rule when it carries
    per-field reasons such as validation failures, but errors that include raw
    text for diagnostic purposes may contain wording in a language other than
    the requested one.

    - Only 500 has a different shape. It returns `message` and a `requestID` to
    reference when contacting support, without `code`.
  title: Platform API
  version: '1.0'
servers:
  - url: http://dev-platform-api.trychainshift.ai/api
security: []
tags:
  - description: >-
      The top-level account unit that API keys belong to. Retrieve the
      organization's basic information.
    name: Organization
  - description: >-
      A target brand whose exposure in AI services is monitored. Provides brand
      registration, retrieval, update, and deletion.
    name: Brand
  - description: >-
      Keyword intelligence for analyzing brands and markets. Provides Google and
      Naver search metrics, related and autocomplete keyword lookups, and site
      URL based keyword analysis.
    name: Keyword (Beta)
  - description: >-
      A group that organizes prompts by purpose. Provides create, get, update,
      and delete operations for prompt sets.
    name: PromptSet
  - description: >-
      A sentence-level unit of a query sent to an AI service. Provides prompt
      create, get, update, and delete, plus bulk creation.
    name: Prompt
  - description: AI service models used for prompt runs. Lists the supported models.
    name: Model
  - description: The region used to run prompts. Retrieves the list of supported regions.
    name: Region
  - description: >-
      The unit of work that actually runs prompts against AI services. Provides
      prompt run requests and retrieval of progress status and lists.
    name: Run
  - description: >-
      An AI service response collected by a run. Retrieves answers including
      sources and search queries.
    name: Answer
  - description: >-
      Statistics on the sources cited in answers, at the domain and URL level.
      Retrieve the citation summary and per-domain and per-URL citation
      statistics.
    name: SourceStatistics (Beta)
  - description: >-
      Statistics on tokens (Kiwi nouns) in answer bodies. Retrieves a ranking of
      the most frequent tokens and the tokens near a specific word.
    name: AnswerStatistics (Beta)
  - description: >-
      Statistics on the search queries (fan-outs) the AI actually issued while
      generating answers. Retrieves a ranking of search queries by occurrence
      count.
    name: FanoutStatistics (Beta)
  - description: >-
      An auxiliary feature that identifies proper nouns in text. Provides proper
      noun extraction.
    name: ProperNoun (Beta)
  - description: >-
      Organization credit balance and Platform API billing information.
      Retrieves the current credit balance.
    name: Credit
externalDocs:
  description: ''
  url: ''
paths:
  /v1/platform/regions:
    get:
      tags:
        - Region
      summary: List regions
      description: >-
        프롬프트 실행 요청(submitRun)의 region 값으로 사용할 수 있는 지원 리전 목록을 조회합니다. model 을 지정하면
        해당 모델이 지원하는 리전만, 생략하면 전체 리전을 반환합니다.

        계약이 필요한 리전은 이 조직에 부여된 경우에만 목록에 포함됩니다.


        ### 오류


        | HTTP | 코드 | 설명 |

        | --- | --- | --- |

        | 400 | `MODEL_NOT_SUPPORTED` | 플랫폼 API 가 지원하지 않는 model 값 |

        | 400 | `MODEL_DISCONTINUED` | 서비스가 중단된 모델을 지정함 (현재 중단된 모델은 없음) |

        | 401 | `COMMON_UNAUTHORIZED` | API 키 또는 액세스 토큰이 없거나 유효하지 않음 |

        | 402 | `INSUFFICIENT_CREDITS` | 조직 크레딧 잔액이 이 요청의 단가보다 적음 |

        | 429 | `PLATFORM_RATE_LIMIT_EXCEEDED` | 요청 한도 초과. `Retry-After` 헤더의 초만큼
        기다린 뒤 재시도 |

        | 500 | — | 서버 내부 오류. `code` 없이 `message` 와 `requestID` 를 반환 |
      operationId: listRegions
      parameters:
        - description: >-
            Model code. When specified, returns only the regions supported by
            that model. Must be a value retrievable from GET /models;
            unsupported models return 400
          example: CHATGPT
          in: query
          name: model
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/github_com_chainshiftlabs_console-api-go_internal_platform_domain.ListRegionsResponse
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.ModelNotSupportedError'
          description: A model value not supported by the Platform API
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.UnauthorizedError'
          description: API key or access token is missing or invalid
        '402':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.InsufficientCreditsError'
          description: >-
            The organization's credit balance is lower than the unit price of
            this request
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.RateLimitExceededError'
          description: >-
            Rate limit exceeded. Wait the number of seconds in the Retry-After
            header, then retry
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.InternalServerError'
          description: >-
            Internal server error. Include the requestID in your report so it
            can be traced
      security:
        - OrgAPIKeyAuth: []
components:
  schemas:
    github_com_chainshiftlabs_console-api-go_internal_platform_domain.ListRegionsResponse:
      properties:
        regions:
          description: Supported regions
          items:
            $ref: '#/components/schemas/domain.RegionItem'
          type: array
          uniqueItems: false
      type: object
    domain.ModelNotSupportedError:
      properties:
        code:
          description: Error code
          example: MODEL_NOT_SUPPORTED
          type: string
        message:
          description: >-
            Error message (Korean by default, English when Accept-Language: en
            is specified)
          example: Model not supported by the Platform API
          type: string
      type: object
    domain.UnauthorizedError:
      properties:
        code:
          description: Error code
          example: COMMON_UNAUTHORIZED
          type: string
        message:
          description: >-
            Error message (Korean by default, English when Accept-Language: en
            is specified)
          example: Unauthenticated user
          type: string
      type: object
    domain.InsufficientCreditsError:
      properties:
        code:
          description: Error code
          example: INSUFFICIENT_CREDITS
          type: string
        message:
          description: >-
            Error message (Korean by default, English when Accept-Language: en
            is specified)
          example: Insufficient credits.
          type: string
      type: object
    domain.RateLimitExceededError:
      properties:
        code:
          description: Error code
          example: PLATFORM_RATE_LIMIT_EXCEEDED
          type: string
        message:
          description: >-
            Error message (Korean by default, English when Accept-Language: en
            is specified)
          example: Too many requests. Please try again later.
          type: string
      type: object
    domain.InternalServerError:
      properties:
        message:
          description: Error message (not localized)
          example: Internal Server Error
          type: string
        requestID:
          description: >-
            Request identifier to reference in support inquiries (same value as
            the X-Request-Id response header)
          example: bkZqnHQepkgTOocTvyHWSlHcGzRqQbZk
          type: string
      type: object
    domain.RegionItem:
      properties:
        code:
          description: Region code (ISO 3166-1 alpha-2)
          example: KR
          type: string
        name:
          description: Region display name (English)
          example: South Korea
          type: string
      type: object
  securitySchemes:
    OrgAPIKeyAuth:
      description: '"Enter your organization API key. Example: ''cs_live_xxxx''"'
      in: header
      name: API-Key
      type: apiKey

````

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