> ## Documentation Index > Fetch the complete documentation index at: https://docs.kodelabs.com/llms.txt > Use this file to discover all available pages before exploring further. # Ingest points through a connector > Adds points to devices you already ingested on a KODE API connector. The work runs as a background job. > [!NOTE] > > The request is checked first and then runs as a job. A `202` response means the job started, not that the points exist yet. Read the job with [Get a job](https://docs.kodelabs.com/products/kode-api/api-reference/buildings/get-a-job.md) until `status` is `COMPLETED`, then read the points back. A job has no result for each item. Send 1 to 1,000 items in one request. Each item describes one point and the device it belongs to. | Member | Meaning | | - | - | | `deviceExternalId`, `deviceExternalPath` | The `deviceExternalId` and `deviceExternalPath` you sent when you ingested the parent device. Required. | | `pointExternalId` | Your own stable identifier for the point. Required. | | `pointExternalPath` | The path of the point in your system. Required. | | `pointName` | The name shown in KODE OS. Required, up to 255 characters. | | `pointKind` | `Number`, `Str`, or `Bool`. Required. The value is case-sensitive. | | `pointUnit` | The `_id` of an ontology unit, for a `Number` point. Optional. | | `pointEnum` | The allowed values as one comma-separated string, such as `off,on,auto`. Optional. | | `pointWritable` | `true` if the point accepts writes. Optional, `false` when you leave it out. | | `pointMinVal`, `pointMaxVal` | The lowest and highest value, as numbers. Optional. `pointMinVal` cannot be higher than `pointMaxVal`. | The request returns `400` before any job starts when: * A parent device was not ingested on this connector. The message lists the missing `deviceExternalId` values. * A `pointUnit` is not an ontology unit. The message lists the unknown ids. * A `pointKind` is not `Number`, `Str`, or `Bool`. * A point has `pointMinVal` higher than `pointMaxVal`. * The connector is not a KODE API connector. Send a `pointExternalId` that exists already and the API does not create a second point. A `buildingId` in the body is ignored. ## OpenAPI ````yaml /openapi/kode-api.yaml post /api/v1/buildings/{buildingId}/connectors/{connectorId}/ingest/points openapi: 3.1.0 info: title: KODE API version: 1.0.0 summary: Programmatic access to KODE OS resources and operations. description: > Use the KODE API to work with buildings, data sources, connectors, devices, points, virtual devices, timeseries data, schedules, the ontology, templating, mass writes, spaces, space assignments, tenants, meters, users, actions, and AssetOps work orders. license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.kodelabs.com/kodeos description: KODE API security: - bearerAuth: [] tags: - name: Authentication description: OAuth 2.0 discovery, token, and revocation endpoints. - name: Buildings description: Buildings and their areas. - name: Data sources description: Data sources connected to a building. - name: Devices description: Devices and their points. - name: Points description: Point queries and point writes. - name: Timeseries description: Current and historical point values. - name: Actions description: Actions exposed by building data sources. - name: Work orders description: AssetOps work orders, lookups, comments, and attachments. - name: Connectors description: KODE API connectors and the devices and points ingested through them. - name: Schedules description: Schedules discovered on building data sources. - name: Templating description: Apply ontology templates to groups of points. - name: Virtual devices description: Virtual devices that group points from other devices. - name: Ontology description: Canonical types, fields, units, and connections of the KODE ontology. - name: Users description: Users of the organization and their app access. - name: Mass write description: Write values to many points across buildings, and follow each run. - name: Spaces description: Levels and space units of a building, and the meters located in them. - name: Space assignments description: Assign tenants to leasable spaces of a building for a period. - name: Tenants description: Tenants of a building, the people or companies that lease its spaces. - name: Meters description: >- Meters of a building, their space assignments, parent and child links, and readings. paths: /api/v1/buildings/{buildingId}/connectors/{connectorId}/ingest/points: post: tags: - Connectors summary: Ingest points through a connector description: >- Adds points to devices you already ingested on a KODE API connector. The work runs as a background job. operationId: ingestConnectorPoints parameters: - $ref: '#/components/parameters/BuildingId' - name: connectorId in: path required: true schema: type: string description: >- ID of a KODE API connector, from `_id` in [Create a KODE API connector](/products/kode-api/api-reference/connectors/create-a-kode-api-connector). requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchIngestPoints' required: true responses: '202': description: The job that was started, with status `PROCESSING`. content: application/json: schema: $ref: '#/components/schemas/JobPublic' '400': description: >- `items` is missing, `null`, empty, or holds more than 1,000 items. A required member is missing. A parent device, a unit, or a `pointKind` is not valid, a minimum is higher than its maximum, or the connector is not a KODE API connector. '401': $ref: '#/components/responses/Unauthorized' '403': description: >- The building does not exist, is not available to your service account, or has no `api` product enabled. Your service account also needs the **Ingest connector points** action. '404': description: No connector with this id exists in this building. '429': $ref: '#/components/responses/TooManyRequests' components: parameters: BuildingId: name: buildingId in: path required: true description: Building identifier from List buildings. schema: type: string example: 67c960faffaa42223163099e schemas: BatchIngestPoints: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/Item' maxItems: 1000 minItems: 1 JobPublic: type: object properties: _id: type: string organizationId: type: string createdAt: $ref: '#/components/schemas/Date' type: string readOnly: true updatedAt: $ref: '#/components/schemas/Date' type: string readOnly: true name: type: string description: type: string status: $ref: '#/components/schemas/JobStatus1' errorMessage: type: string Item: type: object required: - deviceExternalId - deviceExternalPath - pointExternalId - pointExternalPath - pointName - pointKind properties: deviceExternalId: type: string pattern: \S deviceExternalPath: type: string pattern: \S pointExternalId: type: string pattern: \S pointExternalPath: type: string pattern: \S pointName: type: string pattern: \S maxLength: 255 pointKind: type: string pattern: \S pointUnit: type: string pointEnum: type: string pointWritable: type: boolean pointMinVal: type: number format: double pointMaxVal: type: number format: double Date: type: string description: >- Date and time in UTC, with a numeric offset and no colon, for example `2026-10-28T13:51:31+0000`. examples: - 2026-10-28T13:51:31+0000 JobStatus1: type: string enum: - PENDING - PROCESSING - PROCESSED - COMPLETED - FAILED - CANCELED responses: Unauthorized: description: The access token is missing, invalid, or expired. Request a new token. TooManyRequests: description: >- A rate-limit window is exhausted. Wait, then retry with increasing delays. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Paste an access token from [Create an access token](/products/kode-api/api-reference/authentication/create-an-access-token). Tokens expire, so request a new one if you receive `401`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.