Some deepset API endpoints use resource IDs rather than names. For example, to list workspace integrations, you need workspace ID. To obtain the IDs you can either call a REST API endpoint or check the ID in the UI.
Finding IDs in the UI
You can copy all IDs directly from the platform interface.
Workspace ID
Click your profile icon and go to Settings>Workspace>General.
Organization ID
Click your profile icon and go to Settings>Organization>General.
Pipeline ID
- Click Pipelines.
- Find the right pipeline and click its name. This opens the Pipeline Details page. The ID is right below the pipeline name at the top of the page.
Checking the Index ID
- Click Indexes.
- Find the right index and click its name. This opens the Index Details page. The ID is right below the index name at the top of the page.
Checking the Job ID
- Click Jobs.
- Find the right job and click its name. This opens the Job Details page. The ID is right below the job name at the top of the page.
Finding IDs with API Endpoints
Each resource type has a dedicated endpoint that returns its ID.
- To get an organization ID, use the Get Organization endpoint.
- To get a workspace ID, use the Get Workspace By Name endpoint.
- To get a pipeline ID, use the Get Pipeline endpoint.
- To get an index ID, use the Get Index By Name endpoint.
- To get a job ID, use the Get Jobs endpoint.