# Interface ApiEndpoint

API endpoint documentation.

interface ApiEndpoint {
name: string;
description: string;
parameters: {
name: string;
type: string;
description: string;
required: boolean;
}[];
returns: { type: string; description: string };
example?: string;
}

- Defined in packages/nexus-agents/src/agents/experts/expert-documentation-types.ts:47

##### Index

### Properties

name
description
parameters
returns
example?

## Properties

### name

name: string

Endpoint name

- Defined in packages/nexus-agents/src/agents/experts/expert-documentation-types.ts:49

### description

description: string

Description

- Defined in packages/nexus-agents/src/agents/experts/expert-documentation-types.ts:51

### parameters

parameters: {
name: string;
type: string;
description: string;
required: boolean;
}[]

Parameters

- Defined in packages/nexus-agents/src/agents/experts/expert-documentation-types.ts:53

### returns

returns: { type: string; description: string }

Return type

- Defined in packages/nexus-agents/src/agents/experts/expert-documentation-types.ts:60

### `Optional` example

example?: string

Example usage

- Defined in packages/nexus-agents/src/agents/experts/expert-documentation-types.ts:62