Getting started

To make API calls, please follow the subsequent steps.

1. Find your hostname
2. Get an authentication token
3. Make a request

Find your hostname

The hostname is present in all URLs when accessing Palantir applications through the user interface. Find your hostname from your browser's URL address bar while logged into Palantir. The hostname should look like the following: https://<hostname>/.

Get an authentication token

Follow the steps in Authentication to get an authentication token.

Make a request

After getting your hostname and authentication token, you can use API clients to interact with the API.

All API calls to Gotham API should use HTTPS and the hostname for the particular instance.

Example Requests

• cURL

Using cURL

Run the following to call the get object* endpoint to get information a specific object with ID ri.gotham.111111-0.object-internal.111111:

Copied!
1
2
curl -H "Authorization: Bearer <your token>" \
 "https://<hostname>/api/gotham/v1/objects/ri.gotham.111111-0.object-internal.111111"

To send a POST request, use the -d flag to include a POST body and be sure to set a Content-type of application/json.

Run the following to call the create object endpoint and create a new object of type com.palantir.object.person.

Copied!
1
2
3
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <your token>" \
 "https://<hostname>/api/gotham/v1/objects/types/com.palantir.object.person" \
 -d '{"title": "Anna Smith-Doe"}'

OpenAPI Compatibility

This API is available as an OpenAPI-compliant definition. The definition download is available at the following URL:

Copied!
1
2
curl -H "Authorization: Bearer <your token>" \
 "https://<hostname>/api/gotham/openapi"

Authentication is required to access the OpenAPI definition.

Additional information about OpenAPI Generator is available here.