> For the complete documentation index, see [llms.txt](https://docs.veedna.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.veedna.com/gold-open-source-gos/gold-packages/what-is-gos-api.md).

# What is GOS API?

The Lineaje GOS workflow is fully automatable via REST APIs. The following table documents the three core API calls required to execute a complete GOS remediation cycle within a CI/CD pipeline.

All API calls require a Bearer token obtained via one of two authentication methods: 

* **Username / Password**: POST credentials to the identity service to receive an access token (valid 24 hours). 
* **API Key**: Contact [Lineaje Support](https://support.lineaje.com) to provision a long-lived API key for service-to-service authentication. 

### How it works 

The API follows a three-step flow: 

1. **Authenticate**: Exchange your Lineaje credentials for a Bearer token. 
2. **Get your project list**: Retrieve your scanned projects and capture the sbom\_id for the project you want to remediate. 
3. **Request and poll for a fix plan**: Submit the sbom\_id to the fix plan endpoint and poll until the plan status returns as available. 


---

# 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.veedna.com/gold-open-source-gos/gold-packages/what-is-gos-api.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.