v1

latestOpenAPI 3.0.22026-07-174617345.8 KB

Sources

List a certain agent's sources.

Retrieve a list of all sources associated with a given agent (formerly known as project). This endpoint provides a collection of sources that are linked to a specific agent. Sources serve as references or contexts for the agent.

get/api/v1/projects/{projectId}/sources

Path parameters

projectIdinteger required

The unique identifier of the agent (formerly known as project).

Response

Successfully retrieved list of sources that belong to an agent.

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "sitemaps": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml"
        },
        "pages": [
          {
            "id": 1,
            "page_url": "https://example.com",
            "page_url_hash": "d41d8cd98f00b204e9800998ecf8427e",
            "project_id": 1,
            "s3_path": "project-1/page-1/file.pdf",
            "crawl_status": "queued",
            "index_status": "queued",
            "is_file": true,
            "is_refreshable": true,
            "is_file_kept": true,
            "filename": "file.pdf",
            "filesize": 100,
            "created_at": "2021-01-01 00:00:00",
            "updated_at": "2021-01-01 00:00:00",
            "deleted_at": "2021-01-01 00:00:00"
          }
        ]
      }
    ],
    "uploads": {
      "id": 1,
      "created_at": "2021-01-01 00:00:00",
      "updated_at": "2021-01-01 00:00:00",
      "type": "sitemap",
      "settings": {
        "executive_js": true,
        "data_refresh_frequency": "never",
        "create_new_pages": true,
        "refresh_existing_pages": "never",
        "sitemap_path": "https://example.com/sitemap.xml"
      },
      "pages": [
        {
          "id": 1,
          "page_url": "https://example.com",
          "page_url_hash": "d41d8cd98f00b204e9800998ecf8427e",
          "project_id": 1,
          "s3_path": "project-1/page-1/file.pdf",
          "crawl_status": "queued",
          "index_status": "queued",
          "is_file": true,
          "is_refreshable": true,
          "is_file_kept": true,
          "filename": "file.pdf",
          "filesize": 100,
          "created_at": "2021-01-01 00:00:00",
          "updated_at": "2021-01-01 00:00:00",
          "deleted_at": "2021-01-01 00:00:00"
        }
      ]
    }
  }
}