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

# マップの作成

> このエンドポイントを使用すると、特定のウェブサイト上のすべてのURLを取得できます。複雑なウェブサイトの場合、最大120秒かかることがあります。大規模なウェブサイトの場合、結果はカーソルベースのページネーションを使用してページ分割されます。



## OpenAPI

````yaml ja/openapi/maps.json POST /v1/maps
openapi: 3.0.3
info:
  title: Maps API
  version: 1.0.0
servers:
  - url: https://api.olostep.com
security: []
paths:
  /v1/maps:
    post:
      summary: 特定のウェブサイト上のすべてのURLを取得
      description: >-
        このエンドポイントを使用すると、特定のウェブサイト上のすべてのURLを取得できます。複雑なウェブサイトの場合、最大120秒かかることがあります。大規模なウェブサイトの場合、結果はカーソルベースのページネーションを使用してページネートされます。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                  description: リンクを取得したいウェブサイトのURL
                search_query:
                  type: string
                  description: 検索の関連性でリンクをソートするためのオプションの検索クエリ。
                top_n:
                  type: number
                  description: 検索クエリの上位nリンクのみに制限するためのオプションの数。
                include_subdomain:
                  type: boolean
                  description: 指定されたURLのサブドメインを含める。デフォルトは`true`です。
                include_urls:
                  type: array
                  items:
                    type: string
                  description: >-
                    グロブ構文を使用して含めるURLパスパターン。例えば、`/blog/**`はブログURLのみを含めます。これらのパターンに一致するURLのみが返されます。
                exclude_urls:
                  type: array
                  items:
                    type: string
                  description: >-
                    グロブ構文を使用して除外するURLパスパターン。例えば、`/careers/**`。除外されたURLは含まれるURLよりも優先されます。
                cursor:
                  type: string
                  description: >-
                    オプション:
                    前のレスポンスからのページネーションカーソル。指定された場合、前回のリクエストがレスポンスサイズ制限のために終了した場所から次のURLセットを返します。
              required:
                - url
            examples:
              basic:
                value:
                  url: https://docs.olostep.com
              withFilters:
                value:
                  url: https://docs.olostep.com
                  include_urls:
                    - /api-reference/**
                  exclude_urls:
                    - /api-reference/deprecated/**
              withCursor:
                value:
                  cursor: abc123_xyz456
      responses:
        '200':
          description: ページ上で見つかったURLを含む成功したレスポンス。
          content:
            application/json:
              schema:
                type: object
                required:
                  - urls_count
                  - urls
                properties:
                  id:
                    type: string
                    description: このマップのユニークな識別子
                  urls_count:
                    type: integer
                    description: 現在のレスポンスに含まれるURLの数
                  urls:
                    type: array
                    items:
                      type: string
                    description: ページ上で見つかったURLの配列
                  cursor:
                    type: string
                    description: >-
                      10MBのサイズ制限のために制限された次のURLセットを取得するためのページネーションカーソル。nullまたは存在しない場合、すべてのURLが取得されています。
                  credits_consumed:
                    type: integer
                    nullable: true
                    description: このリクエストで消費されたクレジットの数。実行完了後に設定されるよ。クレジットは請求の基準だよ。
                  cost_usd:
                    type: number
                    nullable: true
                    description: >-
                      このリクエストのUSDでの推定コスト。実行完了後に設定されるよ。消費されたクレジットとプランのレートから計算されるよ
                      — 99%の精度だけど、credits_consumedが正確な値だよ。
              examples:
                basicResponse:
                  value:
                    id: map_abc123
                    urls_count: 22
                    urls:
                      - https://docs.olostep.com/api-reference/batches/create
                      - https://docs.olostep.com/api-reference/batches/info
                      - https://docs.olostep.com/api-reference/batches/items
                cursorResponse:
                  value:
                    id: map_abc123
                    urls_count: 15
                    urls:
                      - https://docs.olostep.com/api-reference/crawls/create
                      - https://docs.olostep.com/api-reference/crawls/info
                      - https://docs.olostep.com/api-reference/crawls/pages
                    cursor: abc123_def789
                allRetrievedResponse:
                  value:
                    id: map_abc123
                    urls_count: 10
                    urls:
                      - https://docs.olostep.com/features/maps
                      - https://docs.olostep.com/get-started/authentication
                      - https://docs.olostep.com/get-started/welcome
                    cursor: null
        '400':
          description: 不正なリクエスト。パラメータが間違っているか、欠落しています。
        '401':
          description: 不正なAPIトークンが原因でアクセスが許可されていません。
        '500':
          description: 内部サーバーエラー。
      security:
        - Authorization: []
components:
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: Bearer <token>形式のBearer認証ヘッダー。<token>はあなたの認証トークンです。

````