canonical: https://jentic.com/apis/swaggerhub.tmforum-open-api/agreement-management

# Tmforum Open Api Agreement Management

This is Swagger UI environment generated for the TMF Agreement Management specification. The API exposes 12 endpoints.

## For AI agents

Programmatically creates a 'agreement', list or find 'agreement' objects. Covers 12 operations.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Creates a 'Agreement'
- List or find 'Agreement' objects
- Retrieves a 'Agreement' by Id
- Updates partially a 'Agreement' by Id
- Deletes a 'Agreement' by Id

## Use cases

### Developer Tools Operations

Use the Agreement Management to perform developer tools operations programmatically. The API provides 12 endpoints covering core functionality including creates a 'agreement', list or find 'agreement' objects, retrieves a 'agreement' by id.

Example prompt: Call POST /agreement to creates a 'agreement'

### Automated agreement Management

Automate agreement operations by combining multiple Agreement Management endpoints. Agents can list or find 'agreement' objects and then retrieves a 'agreement' by id in a single workflow.

Example prompt: Call GET /agreement to list or find 'agreement' objects, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Agreement Management endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Example prompt: Search Jentic for 'creates a 'agreement'', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/agreement` | Creates a 'Agreement' |
| GET | `/agreement` | List or find 'Agreement' objects |
| GET | `/agreement/{id}` | Retrieves a 'Agreement' by Id |
| PATCH | `/agreement/{id}` | Updates partially a 'Agreement' by Id |
| DELETE | `/agreement/{id}` | Deletes a 'Agreement' by Id |
| POST | `/agreementSpecification` | Creates a 'AgreementSpecification' |
| GET | `/agreementSpecification` | List or find 'AgreementSpecification' objects |
| GET | `/agreementSpecification/{id}` | Retrieves a 'AgreementSpecification' by Id |

## Key resources

- **agreement** — Operations related to agreement
- **agreementSpecification** — Operations related to agreementSpecification
- **events subscription** — Operations related to events subscription

## Why Jentic

- **Setup:** Wiring the Agreement Management API by hand means targeting its TMF host, mapping the agreement and agreement-specification endpoints, and handling calls and retries yourself. Through Jentic you install once, import Agreement Management from the API Directory, and your agent calls it.
- **Permission scoping:** This API puts the agreement id in the URL path (`/agreement/{id}`), so a rule can pin your agent to one agreement: it can read and patch that agreement and nothing else. You choose the operations it may call, so destructive ones like deleting an agreement are not included unless you add them.
- **Credential handling:** This API is configured without a credential, so there is no secret for the agent to expose; if a credential is added later it is stored once, encrypted, by your own Jentic One instance and injected at execution time, never entering the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create an agreement' or 'read an agreement specification', and Jentic returns the matching Agreement Management operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Agreement Management use?

The Agreement Management uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I creates a 'agreement' with the Agreement Management?

Yes. Use the POST /agreement endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Agreement Management?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I creates a 'agreement' through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'creates a 'agreement''. Jentic returns the matching Agreement Management operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Agreement Management have?

The Agreement Management exposes 12 endpoints covering agreement, agreementspecification, events subscription operations.

### Can I limit what my agent is allowed to do with the Agreement Management API?

Yes. Because you run Jentic One yourself, you write the rules that decide which Agreement Management operations and credentials your agent may use. Since the agreement id lives in the URL path (`/agreement/{id}`), you can pin the agent to a single agreement so it only reads and patches that record and nothing else. You also pick the exact operations it may call, so a destructive action like DELETE `/agreement/{id}` is left out unless you explicitly add it.