List sources.

Changed on Nov 3, 2026

Returns all data sources connected to an agent. Each source represents an origin for documents - such as a sitemap, Google Drive folder, SharePoint site, or uploaded files. Use this to manage what content feeds into an agent's knowledge base.

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

Request

Base URL
https://app.customgpt.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/poll-the-people/apis/customgpt-ai/docs/api/v1/projects/:projectId/sources/get.ts
A function with typed inputs. Its response is checked against the schema.

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": {
    "uploads": {
      "id": 1,
      "created_at": "2021-01-01 00:00:00",
      "updated_at": "2021-01-01 00:00:00",
      "type": "sitemap",
      "sub_type": "images-opengraph",
      "settings": {
        "executive_js": true,
        "data_refresh_frequency": "never",
        "create_new_pages": true,
        "refresh_existing_pages": "never",
        "sitemap_path": "https://example.com/sitemap.xml",
        "image_extraction_type": "sync_from_sitemap"
      },
      "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"
        }
      ]
    },
    "sitemaps": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "zapiers": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "confluences": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "youtubes": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "vimeos": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "podcasts": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "rsses": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "linkedins": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "sharepoints": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "sharepoint_sites": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "one_drives": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "google_drives": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "notions": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "zendesks": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ],
    "hubspots": [
      {
        "id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "type": "sitemap",
        "sub_type": "images-opengraph",
        "settings": {
          "executive_js": true,
          "data_refresh_frequency": "never",
          "create_new_pages": true,
          "refresh_existing_pages": "never",
          "sitemap_path": "https://example.com/sitemap.xml",
          "image_extraction_type": "sync_from_sitemap"
        },
        "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"
          }
        ]
      }
    ]
  }
}

Changes

Nov 3, 202677aab4354382 Revision changes
- warning
  added the new 422.00 enum value to the / response property for the response status
- warning
  added the new 422.00 enum value to the / response property for the response status
- warning
  added the new advanced enum value to the //// response property for the response status
- warning
  added the new advanced enum value to the /// response property for the response status
- warning
  added the new always enum value to the //// response property for the response status
- warning
  added the new always enum value to the /// response property for the response status
- warning
  added the new daily enum value to the //// response property for the response status
- warning
  added the new daily enum value to the /// response property for the response status
- warning
  added the new if_updated enum value to the //// response property for the response status
- warning
  added the new if_updated enum value to the /// response property for the response status
- warning
  added the new monthly enum value to the //// response property for the response status
- warning
  added the new monthly enum value to the /// response property for the response status
- warning
  added the new never enum value to the //// response property for the response status
- warning
  added the new never enum value to the //// response property for the response status
- warning
  added the new never enum value to the /// response property for the response status
- warning
  added the new never enum value to the /// response property for the response status
- warning
  added the new web-images enum value to the /// response property for the response status
- warning
  added the new web-images enum value to the // response property for the response status
- warning
  added the new weekly enum value to the //// response property for the response status
- warning
  added the new weekly enum value to the /// response property for the response status
- info
  added the non-success response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  removed the never always if_updated enum value from the //// response property for the response status
- info
  removed the never always if_updated enum value from the /// response property for the response status
- info
  removed the never daily weekly monthly advanced enum value from the //// response property for the response status
- info
  removed the never daily weekly monthly advanced enum value from the /// response property for the response status
Jul 17, 2026b80e6dfcf78d Revision changes
- breaking
  the ///// response's property format changed from binary to no format for status
- breaking
  the //// response's property format changed from binary to no format for status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  added the new never daily weekly monthly advanced enum value to the //// response property for the response status
- warning
  added the new never daily weekly monthly advanced enum value to the /// response property for the response status
- info
  removed the non-success response with the status
- info
  removed the non-success response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status

Operation history (6 revisions)