> For the complete documentation index, see [llms.txt](https://help.claritylims.illumina.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.claritylims.illumina.com/api-and-database/api-docs/tips-and-tricks/creating-samples-and-projects-via-the-api.md). # Creating Samples and Projects via the API ### Assumptions The incoming message contains the following: * Project ID or Name * Sample ID or Name * Container ID or Name * Container type (plate / tube type) * Container well position (if sample is on a plate) eg G:2 * Sample user-defined fields (UDFs) / custom fields ### Main Logic ``` Does the project exist?     if NO: create it Does the container exist?     if NO: create it Create sample ``` ### Create a Sample: **POST** to : ```     20140909-1                            1:1          Cane Toad ``` We receive something like the following: ```     20140909-1     2014-09-10                   System         Administrator               Cane Toad ``` #### Create a Project: **POST** to ```       Week 39       2014-09-10        ``` We receive something like the following: 
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<prj:project uri="https://your_server/api/v2/projects/ADM372" limsid="ADM372">
    <name>Week 39</name>
    <open-date>2014-09-10</open-date>
    <researcher uri="https://your_server/api/v2/researchers/1" />
</prj:project> 
#### Create a Container (tube): **POST** to : ```       Example Container 20140910        ``` We receive something like the following: 
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<con:container uri="https://your_server/api/v2/containers/27-1869" limsid="27-1869">
    <name>Example Container 20140910</name>
    <type uri="https://your_server/api/v2/containertypes/2" name="Tube" />
    <occupied-wells>0</occupied-wells>
    <state>Empty</state>
</con:container>
#### Create a Container (96 well plate): **POST** to : ```     Example Plate 20140910        ``` We receive something like the following: 
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<con:container uri="https://your_server/api/v2/containers/27-1870" limsid="27-1870">
    <name>Example Plate 20140910</name>
    <type uri="https://your_server/api/v2/containertypes/1" name="96 well plate" />
    <occupied-wells>0</occupied-wells>
    <state>Empty</state>
</con:container> 
#### Create a Sample in the 96 Well Plate Rreated, and the Project Created: **POST** to : 
<?xml version="1.0" encoding="UTF-8"?>
<smp:samplecreation xmlns:smp="http://genologics.com/ri/sample" xmlns:udf="http://genologics.com/ri/userdefined">
      <name>20140909-1</name>
      <project uri="https://your_server/api/v2/projects/ADM372"></project>
      <location>
            <container uri="https://your_server/api/v2/containers/27-1870"></container>
            <value>G:2</value>
      </location>
      <udf:field name="Reference Genome">Cane Toad</udf:field>
</smp:samplecreation>
We receive something like the following: 
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<smp:sample uri="https://your_server/api/v2/samples/ADM372A2" limsid="ADM372A2">
    <name>20140909-1</name>
    <date-received>2014-09-10</date-received>
    <project limsid="ADM372" uri="https://your_server/api/v2/projects/ADM372" />
     <submitter uri="https://your_server/api/v2/researchers/1">
        <first-name>System</first-name>
        <last-name>Administrator</last-name>
    </submitter>
    <artifact limsid="ADM372A2PA1" uri="https://your_server/api/v2/artifacts/ADM372A2PA1?state=4264" />
    <udf:field type="String" name="Reference Genome">Cane Toad</udf:field>
 </smp:sample>
#### Confirm the Project Exists **GET**: \*\* If the project exists, we receive something like the following: 
<prj:projects xmlns:prj="http://genologics.com/ri/project">
    <project uri="https://your_server/api/v2/projects/ADM372" limsid="ADM372">
        <name>Week 39</name>
    </project>
</prj:projects>
If the project does not exist, we receive something like the following: ``` ``` #### Confirm the Container Exists **GET:** \*\* If the container exists, we receive something like the following: 
<con:containers xmlns:con="http://genologics.com/ri/container">
    <container uri="https://your_server/api/v2/containers/27-1869" limsid="27-1869">
        <name>Example Container 20140910</name>
    </container>
</con:containers>
If the container does not exist, we receive something like the following: ``` ``` --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.claritylims.illumina.com/api-and-database/api-docs/tips-and-tricks/creating-samples-and-projects-via-the-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.