> For the complete documentation index, see [llms.txt](https://docs.struct.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.struct.com/tutorials/guides/how-to-use-struct-pims-api/how-to-set-up-and-edit-api-configurations.md).

# How to set up and edit API configurations

Establishing connection to Struct PIMs API.

## Getting started

To create a new API configuration, navigate to the API configurations page in the PIM system and click on the "Create API Configuration" button located in the top right corner.

<figure><img src="https://2141378775-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FuUonpFWM7AJ0xVVXV1tr%2Fuploads%2FQZYAldguzF0L1gp8jUMt%2Fimage.png?alt=media&amp;token=1036d76b-76c7-46b9-9adf-4645c72ea696" alt=""><figcaption><p>API configuration page</p></figcaption></figure>

This will present you with the API configurations setup page.

<figure><img src="https://2141378775-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FuUonpFWM7AJ0xVVXV1tr%2Fuploads%2F8O1cm2pLq0iBixV1pp5b%2Fimage.png?alt=media&amp;token=4b2afb71-3861-4a2f-902c-282e4e837e7e" alt=""><figcaption><p>API configurations setup page</p></figcaption></figure>

To configure the API, first assign a name to the API key for identification purposes. The subsequent fields, "API Key" and "API URL," should contain the generated key and the URL where the API is accessible.

Afterwards you will have the options to specify what kind of access to grant the API key.&#x20;

When you are done with the configurations you can click the "Save"-button in the bottom right to save and generate the key.

## Example of API configurations

In the example below you will see the API key generated, which is needed in order to access the API endpoints. The name of the API key is to clarify that it is made for testing.

<figure><img src="https://2141378775-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FuUonpFWM7AJ0xVVXV1tr%2Fuploads%2FDzvyMXJ8Tki7BDCbHE4e%2Fimage.png?alt=media&amp;token=28e3f6a4-ba2c-4824-bf63-4f4d092b214c" alt=""><figcaption><p>Example of API configuration</p></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.struct.com/tutorials/guides/how-to-use-struct-pims-api/how-to-set-up-and-edit-api-configurations.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
